Sign in

v1

latestOpenAPI 3.0.02026-07-2464438356.8 KB
Webhooks

Create webhook

Creates a new webhook endpoint in DISABLED state. Limited to 5 webhooks per organization.

post/api/webhooks

Request body

categoriesstring[] required

Event categories to subscribe to

urlstring required

HTTPS URL endpoint where webhook events will be delivered

Example request

{
  "categories": [
    "MURAL_ACCOUNT_BALANCE_ACTIVITY"
  ],
  "url": "https://api.example.com/webhooks"
}

Response

Webhook created successfully

categoriesstring[] required

Event categories this webhook is subscribed to

createdAtstring date-time required

When the webhook was created

idstring required

Unique webhook identifier

publicKeystring required

ECDSA public key in PEM format for signature verification

status'DISABLED' | 'ACTIVE' required

Webhook status

updatedAtstring date-time required

When the webhook was last updated

urlstring required

Webhook endpoint URL

versionnumber required

Webhook version for tracking changes