BRbridge
Webhooks

Update a webhook

Changed on

Update the specified webhook object

put/webhooks/{webhookID}

Request

  • Base URL
    https://api.bridge.xyz/v0
  • URL
    https://api.bridge.xyz/v0/webhooks/{webhookID}
  • Auth
    API key in header Api-Key

Request body

urlstring

The new HTTPS URL that Bridge will send events to.

status'active' | 'disabled'

The new status of the webhook endpoint. If set to "active", the webhook will be enabled and will send requests to the new URL. If set to "disabled", the webhook will be disabled and will not send requests to the URL.

event_categoriesWebhookEventCategory[]

The list of event categories that the webhook endpoint will receive. Note that if modified, the webhook endpoint will receive events for new categories only from the current point onwards.

Response

Successful webhook object response

idstring required

An identifier that uniquely identifies the webhook endpoint

urlstring required

The URL that the webhook will send events to

status'active' | 'disabled' | 'deleted' required

The status of the webhook. Only active webhooks will receive events automatically.

public_keystring required

The public key (in PEM format) that should be used to verify the authenticity of webhook events

event_categoriesWebhookEventCategory[]

The list of event categories that the webhook endpoint will receive

Changes

  • a390532e9fc6Revision changes
    • warning

      added the new rfi enum value to the / response property for the response status

    • info

      added the new rfi enum value to the request property /