Matchai Docs

Update a webhook subscriptionComing soon

Changes the endpoint, the events, or turns the subscription off or on.

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

Coming soon. Changes the endpoint, the events, or turns the subscription off or on.

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

Path Parameters

webhook_subscription_id*string

Webhook subscription id.

Length1 <= length <= 64

Request Body

application/json
  1. body
Properties1 <= properties
url?string

Your endpoint.

Formaturi
events?array<>

Replaces the list.

Items1 <= items
description?|

Your note.

Lengthlength <= 200
status?string

Re-enabling a subscription that was failing resumes deliveries from now on.

Value in"enabled""disabled"

Response Body

The subscription.

application/json
  1. response
id*string

Subscription id.

Length1 <= length <= 64
url*string

Your endpoint. https only.

Formaturi
description?|

Your note.

events*array<>

Events sent to this endpoint.

status*string
Value in"enabled""disabled"
disabled_reason?|null
created_at*string

Created.

Formatdate-time
updated_at*string

Last changed.

Formatdate-time
Example Request
curl -X PATCH 'https://api.matchai.co/v1/webhook-subscriptions/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "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"}