Skip to main content
List Webhooks

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Query Parameters

id
string

Webhook ID

created_at
string

Webhook creation date

updated_at
string

Latest update

organisation_id
string

Organisation ID

name
string

Name of webhook

source
string

Source of webhook

active
string

Is the webhook active?

target_url
string

Target url of webhook

headers
string

Header of webhook

method
string

Webhook method

event
string

Event of webhook

select
string

Filtering Columns

order
string

Ordering. Allowed Fields: name

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

200 - application/json

OK

id
string<uuid>
default:random uuid

Webhook ID

created_at
string<timestamp with time zone>
default:now()

Webhook creation date

updated_at
string<timestamp with time zone>
default:now()

Latest update

organisation_id
string<uuid>

Organisation ID

name
string<text>

Name of webhook

source
enum<string>
default:(auth.role())

Source of webhook

Available options:
zapier,
n8n,
make,
authenticated
active
boolean<boolean>
default:true

Is the webhook active?

target_url
string<text>

Target url of webhook

headers
object

Header of webhook

method
enum<string>
default:POST

Webhook method

Available options:
GET,
POST,
PUT,
PATCH
event
enum<string>

Event of webhook

Available options:
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