Matchai Docs

Rotate the signing secretComing soon

Issues a new signing secret. For 24 hours, deliveries carry signatures from both the old and the new secret, so you can switch without missing events.

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

Coming soon. Issues a new signing secret. For 24 hours, deliveries carry signatures from both the old and the new secret, so you can switch without missing events.

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

Header Parameters

Idempotency-Key?string

A unique string (a UUID works). Retrying with the same key within 24 hours returns the first response instead of acting twice. Reusing a key with a different body returns 409 idempotency_key_reused.

Length1 <= length <= 255

Response Body

The subscription, with its new secret.

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
secret*string

The signing secret. Shown once: store it now.

Match^whsec_[A-Za-z0-9]+$
Example Request
curl -X POST 'https://api.matchai.co/v1/webhook-subscriptions/string/rotate-secret' \  -H 'Idempotency-Key: 6f1d3c2a-0b7e-4f5a-9c8d-1e2f3a4b5c6d'
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",  "secret": "string"}