Get Webhook

GET /webhooks/:webhookId

Returns an existing webhook.

• Request headers required. See Request Headers for more information.

• Authentication required. See Authentication Headers for more information.

Permissions Required

• Webhooks:Read

Response

{
  "id": "wh-xxx-xxxxxxx",
  "url": "https://example.com/my/webhook/endpoint",
  "events": [
    "wallet.transfer.initiated",
    "wallet.transfer.executed",
    "wallet.transfer.confirmed",
  ],
  "description": "My awesome webhook, it's so great",
  "status": "Enabled",
  "dateCreated": "2023-11-01T08:52:01.186Z",
  "dateUpdated": "2023-11-01T08:52:01.186Z",
}

Property	Type	Description
id	String	ID of the webhook
url	String	The webhook endpoint url where events will be pushed. The url needs to be a valid http / https url.
description	String - Optional	Description of what the endpoint is for. May be unset.
status	String	Possible values: Enabled | Disabled. If webhook status is Disabled, no event will be pushed to the webhook endpoint. If status is not specified, default status is Enabled.
events	String List	List of supported events the webhook subscribes to. You can also subscribe to all events by passing events: ["*"].
dateCreated	String	ISO 8601 string representing date of creation of the webhook
dateUpdated	String	ISO 8601 string representing date of update of the webhook