ARarkhq-io
Platform Webhooks

Update a platform webhook

Changed on

Update a platform webhook's configuration.

You can update:

  • name - Display name for the webhook
  • url - The endpoint URL (must be HTTPS)
  • events - Array of event types to receive (empty array = all events)
  • enabled - Enable or disable the webhook
patch/platform/webhooks/{webhookId}

Request

Request body

namestring

Display name for the webhook

urlstring uri

Webhook endpoint URL (must be HTTPS)

eventsstring[]

Events to subscribe to. Empty array means all events.

enabledboolean

Enable or disable the webhook

Response

Platform webhook updated

successtrue required

Example response

{
  "data": {
    "id": "pwh_abc123def456"
  },
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}

Changes