webhooks

Create webhook

Create a webhook subscription. The signing secret is never returned.

post/v1/webhooks

Request

Base URL: https://api.botdog.co
URL: https://api.botdog.co/v1/webhooks
Auth: API key in header x-api-key

Request body

namestring required

A human-readable name for the webhook

endpointstring required

The URL that will receive event notifications (POST)

eventTypesstring[] required

The event types to subscribe to

campaignIdsstring[]

Restrict delivery to specific campaign IDs (default: all)

Example request

{
  "endpoint": "https://example.com/hooks/botdog"
}

Response

idstring required

The unique identifier of the webhook

namestring required

A human-readable name for the webhook

endpointstring required

The URL that receives event notifications

statusstring required

The webhook status

scopestring required

Delivery scope. ALL and SPECIFIC_CAMPAIGNS carry campaign events; CONNECTED_ACCOUNT carries events that belong to no campaign, such as inbox messages from outside your campaigns.

typestring required

The webhook type

isTeamWebhookboolean required

Whether the webhook is shared across the team

eventTypesstring[] required

Event types this webhook is subscribed to

campaignIdsstring[] required

Campaign IDs this webhook is scoped to (empty when scope is ALL)

createdAtstring date-time required

When the webhook was created

updatedAtstring date-time required

When the webhook was last updated

Example response

{
  "endpoint": "https://example.com/hooks/botdog",
  "status": "ACTIVE",
  "scope": "ALL",
  "type": "GENERIC",
  "eventTypes": [
    "LEAD_INVITATION_ACCEPTED",
    "LEAD_MESSAGE_REPLIED"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.