v1

latestOpenAPI 3.0.22026-07-24800528.1 KB
Webhooks

List all webhooks

Returns a list of your webhooks. The webhooks are returned sorted by creation date, with the most recent webhooks appearing first.

get/v2/webhooks

Query parameters

limitinteger

A limit on the number of items to be returned. Limits can range between 1 and 250, and the default is 10.

starting_afterstring

A cursor for use in pagination, starting_after takes in an item key and the subsequent call will return the following items in the list. This is mutually exclusive with ending_before.

ending_beforestring

A cursor for use in pagination, ending_before takes in an item key and the subsequent call will return the prior items in the list. This is mutually exclusive with starting_after.

Response

Returns a list of your webhooks. The webhooks are returned sorted by creation date, with the most recent webhooks appearing first.

messagestring required
statusinteger required

Example response

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