Skip to main content
POST
/
v1
/
webhooks
Create webhook
curl --request POST \
  --url https://api.timelyai.com.br/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "events": []
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "url": "<string>",
    "events": [
      "<string>"
    ],
    "is_active": true,
    "secret": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
x-api-key
string
header
required

API key obtained from the dashboard

Body

application/json
​
name
string
required
Required string length: 1 - 100
​
url
string<uri>
required
​
events
enum<string>[]
required
Minimum array length: 1
Available options:
conversation.created,
conversation.closed,
conversation.transferred,
message.received,
message.sent,
contact.created,
contact.updated,
appointment.created,
appointment.cancelled,
appointment.completed

Response

Webhook created

​
data
object