FIfireblocks
Webhooks V2

Get webhook by id

Retrieve a webhook by its id

get/webhooks/{webhookId}

Request

Path parameters

webhookIdstring uuid required
Example:44fcead0-7053-4831-a53a-df7fb90d440f

The unique identifier of the webhook

Response

A webhook object

idstring uuid required

The id of the webhook

urlstring required

The url of the webhook where notifications will be sent. Must be a valid URL and https.

descriptionstring

description of the webhook of what it is used for

eventsWebhookEvent[] required

The events that the webhook will be subscribed to

status'DISABLED' | 'ENABLED' | 'SUSPENDED' required

The status of the webhook

createdAtinteger required

The date and time the webhook was created in milliseconds

updatedAtinteger required

The date and time the webhook was last updated in milliseconds

webhookMtlsIdstring uuid

The id of the mTLS configuration this webhook presents when delivering, from /v1/webhooks_settings/mtls. Absent when the webhook does not use mTLS.

webhookOauthIdstring uuid

The id of the OAuth credentials this webhook authenticates with. Absent when the webhook does not use OAuth. Read the credentials themselves from /v1/webhooks_settings/oauth/{webhookOauthId}.

customHeadersstring[]

Names of the custom headers configured for this webhook. Header values are never returned.

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "url": "https://example.com/webhook",
  "description": "This webhook is used for transactions notifications",
  "events": [
    "transaction.created",
    "transaction.status.updated"
  ],
  "status": "ENABLED",
  "createdAt": 1625126400000,
  "updatedAt": 1625126400000,
  "webhookMtlsId": "6f1b7c62-0f2e-4f1a-9a5e-9f2b1c3d4e5f",
  "webhookOauthId": "123e4567-e89b-12d3-a456-426614174000",
  "customHeaders": [
    "x-gateway-key",
    "x-region-tag"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.