v1

latestOpenAPI 3.1.02026-08-0612447737.4 KB

Webhook

Create Webhook

Create a new webhook

post/webhook

Query parameters

selectstring

Filtering Columns

Request body

idstring uuid

Webhook ID

created_atstring timestamp with time zone

Webhook creation date

updated_atstring timestamp with time zone

Latest update

organisation_idstring uuid

Organisation ID

namestring text

Name of webhook

source'zapier' | 'n8n' | 'make' | 'authenticated' public.webhook_source

Source of webhook

activeboolean

Is the webhook active?

target_urlstring text

Target url of webhook

headersobject

Header of webhook

method'GET' | 'POST' | 'PUT' | 'PATCH' public.http_method

Webhook method

event'contact.created' | 'contact_details.updated' | 'contact.deleted' | 'conversation.inbound' | 'conversation.tag' | 'conversation.untag' | 'conversation.assign' | 'conversation.unassign' | 'conversation.submission_error' | 'conversation.sending_error' | 'conversation.outbound' | 'conversation.reopen' | 'conversation.close' | 'form_submission.completed' | 'form_submission.aborted' | 'contact.updated' public.webhook_event

Event of webhook

Response

The updated Webhook object

idstring uuid

Webhook ID

created_atstring timestamp with time zone

Webhook creation date

updated_atstring timestamp with time zone

Latest update

organisation_idstring uuid

Organisation ID

namestring text

Name of webhook

source'zapier' | 'n8n' | 'make' | 'authenticated' public.webhook_source

Source of webhook

activeboolean

Is the webhook active?

target_urlstring text

Target url of webhook

headersobject

Header of webhook

method'GET' | 'POST' | 'PUT' | 'PATCH' public.http_method

Webhook method

event'contact.created' | 'contact_details.updated' | 'contact.deleted' | 'conversation.inbound' | 'conversation.tag' | 'conversation.untag' | 'conversation.assign' | 'conversation.unassign' | 'conversation.submission_error' | 'conversation.sending_error' | 'conversation.outbound' | 'conversation.reopen' | 'conversation.close' | 'form_submission.completed' | 'form_submission.aborted' | 'contact.updated' public.webhook_event

Event of webhook