BRbridge
Webhooks

Delete a webhook

Changed on

Delete the specified webhook object. This webhook will no longer be accessible via API.

delete/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

Response

Successfully deleted webhook 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