Webhook subscription management
List subscriptions
Retrieves a list of all webhook subscriptions for the authenticated user/client.
Responses
target_urlstring · url · requiredThe URL to send webhook events to
event_typestring · enum · requiredThe event type this subscription is for
Enum values:contact.createdcontact.updatedidinteger · readOnlySubscription ID
created_atstring · date-time · readOnlyTimestamp of when the subscription was created
updated_atstring · date-time · readOnlyTimestamp of when the subscription was last updated
Create a Subscription
Creates a new webhook subscription for a specific event.
Request Body
target_urlstring · url · requiredThe URL to send webhook events to
event_typestring · enum · requiredThe event type this subscription is for
Enum values:contact.createdcontact.updated
Responses
target_urlstring · url · requiredThe URL to send webhook events to
event_typestring · enum · requiredThe event type this subscription is for
Enum values:contact.createdcontact.updatedidinteger · readOnlySubscription ID
created_atstring · date-time · readOnlyTimestamp of when the subscription was created
updated_atstring · date-time · readOnlyTimestamp of when the subscription was last updated
Get a subscription
Retrieves details of a specific webhook subscription by its ID.
path Parameters
idstring · requiredThe ID of the webhook subscription.
Responses
target_urlstring · url · requiredThe URL to send webhook events to
event_typestring · enum · requiredThe event type this subscription is for
Enum values:contact.createdcontact.updatedidinteger · readOnlySubscription ID
created_atstring · date-time · readOnlyTimestamp of when the subscription was created
updated_atstring · date-time · readOnlyTimestamp of when the subscription was last updated
Update a subscription
Updates an existing webhook subscription.
path Parameters
idstring · requiredThe ID of the webhook subscription.
Request Body
target_urlstring · urlThe URL to send webhook events to (optional for update)
event_typestringThe event type this subscription is for (optional for update)
Responses
target_urlstring · url · requiredThe URL to send webhook events to
event_typestring · enum · requiredThe event type this subscription is for
Enum values:contact.createdcontact.updatedidinteger · readOnlySubscription ID
created_atstring · date-time · readOnlyTimestamp of when the subscription was created
updated_atstring · date-time · readOnlyTimestamp of when the subscription was last updated