Skip to main content
POST
/
webhooks
Error
A valid request URL is required to generate request examples
{
  "status": "ok",
  "data": {
    "id": 789456,
    "event_type": "message:sent:new",
    "enabled": true,
    "url": "http://www.example.com/api/hook",
    "errors_counter": 0
  }
}
{
  "message": "<string>",
  "status": "error",
  "error_code": "validation_error",
  "errors": [
    {
      "fields": [
        "url"
      ],
      "msg": "must be a valid http(s) URL"
    }
  ]
}
{
  "message": "<string>",
  "status": "error",
  "error_code": "validation_error",
  "errors": [
    {
      "fields": [
        "url"
      ],
      "msg": "must be a valid http(s) URL"
    }
  ]
}
{
  "message": "<string>",
  "status": "error",
  "error_code": "validation_error",
  "errors": [
    {
      "fields": [
        "url"
      ],
      "msg": "must be a valid http(s) URL"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

A JSON describing webhook.

A client‑defined subscription that instructs TimelinesAI to send an HTTP POST request to the specified url whenever the chosen event_type occurs in the workspace. The POST body is delivered as JSON and contains the event payload.

​
event_type
enum<string>
required

Event topic that will trigger the webhook. For the current list of supported values see the Webhooks events documentation (for example: message:sent:new, message:received:new).

Available options:
message:new,
message:sent:new,
message:received:new,
whatsapp:account:connected,
whatsapp:account:disconnected,
whatsapp:account:suspended,
whatsapp:account:resumed,
chat:new,
chat:incoming:new,
chat:outgoing:new,
chat:responsible:assigned,
chat:responsible:unassigned,
call:incoming:missed,
call:incoming:ended,
call:outgoing:ended,
message:reaction
Example:

"message:sent:new"

​
url
string
required

Destination HTTPS endpoint that TimelinesAI will call. Must be publicly accessible and respond with 2xx status within 5 seconds. The URL must be a structurally valid http(s):// URL — TimelinesAI rejects URLs that contain characters or shapes that would prevent a standard HTTP client from dispatching to them (for example, unescaped + or = in the userinfo portion). The validator runs on POST /webhooks and PUT /webhooks/{id}; a malformed URL is rejected with 400 validation_error.

Maximum string length: 4096
Example:

"http://www.example.com/api/hook"

​
enabled
boolean

Flag indicating whether the subscription is active. When false, deliveries are paused but the definition is kept.

Example:

true

Response

Success

Standard envelope returning a single webhook in the data field.

​
status
enum<string>
required
Available options:
ok,
error
Example:

"ok"

​
data
object
required

Server generated representation of a webhook subscription including its unique identifier and delivery error statistics.