Skip to main content
Create Webhook
curl --request POST \
  --url https://integration.getmateo.com/api/v1/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "random uuid",
  "created_at": "now()",
  "updated_at": "now()",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "source": "(auth.role())",
  "active": true,
  "target_url": "<string>",
  "headers": {},
  "method": "POST",
  "event": "contact.created"
}
'
{
  "id": "random uuid",
  "created_at": "now()",
  "updated_at": "now()",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "source": "(auth.role())",
  "active": true,
  "target_url": "<string>",
  "headers": {},
  "method": "POST",
  "event": "contact.created"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
select
string

Filtering Columns

Body

application/json

webhook

​
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:
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

Response

The updated Webhook object

​
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:
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