POST
/
webhooks
/
subscribe
curl --request POST \
  --url https://api.thoughtly.com/webhooks/subscribe \
  --header 'Content-Type: application/json' \
  --header 'team_id: <api-key>' \
  --header 'x-api-token: <api-key>' \
  --data '{
  "type": "NEW_RESPONSE",
  "data": "<string>",
  "url": "<string>"
}'
{
  "error": {},
  "data": {}
}

Authorizations

​
x-api-token
string
header
required

API key for the user making the request. This can be found via the Developer Settings page in the dashboard.

​
team_id
string
header
required

Team identifier, used to scope requests to a specific team. This can be found via the Developer Settings page in the dashboard.

Body

application/json
​
type
enum<string>
required

The type of webhook event to subscribe to. Choose 'NEW_RESPONSE' for new call responses or 'PHONE_TRANSFER' for phone call transfers.

Available options:
NEW_RESPONSE,
PHONE_TRANSFER
Example:

"NEW_RESPONSE"

​
url
string
required

The callback URL where the webhook should send the event.

​
data
string | null

Additional data that can be included with the webhook event. This is optional.

Response

200 - application/json
Successful response

The generic response format for all API requests. This structure ensures consistency in how success and error information is returned to the caller.

​
data
object
required

Contains the response data for the successful request. This field will vary based on the specific API endpoint being called and contains the main data returned from the API. For example, it may include information about a created contact, agent, or webhook subscription.

​
error
object | null

An object containing error details, if any. This field will be populated if the API request fails or encounters an error. If the request is successful, this field will be null or omitted.

Was this page helpful?