Sign in

v1

latestOpenAPI 3.0.22026-07-24800528.1 KB
Webhooks

Create a webhook

Webhooks deliver POST requests to the target URL when the specified events are triggered.

post/v2/webhooks

Request body

eventsstring[] required

A list of events to send to the registered Webhook.

target_urlstring uri required

URL endpoint Webhook data will be sent to.

Example request

{
  "events": [
    "deal.created",
    "deal.updated"
  ],
  "target_url": "https://jsonplaceholder.typicode.com/posts"
}

Response

Webhooks deliver POST requests to the target URL when the specified events are triggered.

messagestring required
statusinteger required

Example response

{
  "data": {
    "created_at": 1574181282399,
    "key": "co_a80cb515fe",
    "updated_at": 1574181282399,
    "events": [
      "deal.created",
      "deal.updated"
    ],
    "target_url": "https://jsonplaceholder.typicode.com/posts"
  }
}