v1

latestOpenAPI 3.0.02026-07-247150151.6 KB

Webhooks

Update a webhook subscription

Updates a webhook subscription

patch/webhooks/{webhook_id}

Path parameters

webhook_idstring required

Webhook ID

Request body

urlstring

Webhook callback URL

descriptionstring

Optional description of the webhook's intended use

eventsstring[]

List of events enabled in the webhook subscription

versionstring

version of webhook event envelope

status'STATUS_ENABLED' | 'STATUS_DISABLED'

status of webhook. enabled or disabled

Example request

{
  "url": "https://hostname.com/webhook/route",
  "description": "KYC state changes.",
  "version": "0.1",
  "status": "STATUS_ENABLED"
}

Response

Example response

{
  "webhook_subscription": {
    "id": "487a7f29-7b80-467d-b20d-7b60c3a14cf0",
    "url": "https://hostname.com/webhook/route",
    "description": "KYC state changes.",
    "version": "0.1",
    "status": "enabled",
    "creted_time": "2022-06-09T18:23:37.585421Z",
    "updated_time": "2022-06-09T18:23:37.585421Z"
  }
}