Matchai Docs

List webhook subscriptionsComing soon

Returns this connection’s webhook subscriptions.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
GET
/webhook-subscriptions

Coming soon. Returns this connection’s webhook subscriptions.

Scopes: webhooks:manage

Pricing: Included with the connection.

Authorization

headerAuthorizationBearer <matchai_<base62>>

A personal API key, sent as Authorization: Bearer matchai_…. Create keys in Matchai under Settings → Connectors → Advanced (for developers). A key starts with matchai_ followed by letters and digits, carries the scopes chosen when it was created, and can be revoked at any time. Keys reach only the account that created them: to serve other professionals, use Connect with Matchai.

Scope: webhooks:manage

Query Parameters

limit?integer

How many results per page.

Range1 <= value <= 100
Default25
cursor?string

The next_cursor of the previous page. Cursors expire after 24 hours.

Lengthlength <= 512

Response Body

One page of subscriptions.

application/json
  1. response

One page of results. Pass next_cursor as cursor to get the next page; it is null on the last page.

data*array<>
next_cursor*|

Cursor for the next page, or null when there are no more results.

Example Request
curl -X GET 'https://api.matchai.co/v1/webhook-subscriptions'
Example Response
{  "data": [    {      "id": "string",      "url": "http://example.com",      "description": "string",      "events": [        "lead.created"      ],      "status": "enabled",      "disabled_reason": "by_you",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string"}