Skip to main content
Get a Webhook Endpoint V2
Use this endpoint to retrieve a single webhook endpoint by its ID. The response carries the endpoint’s URL, its subscribed events, its apiVersion, and its current state. The signing secret is not part of the response. It is returned only when the endpoint is created, so if you no longer hold it, delete the endpoint and register a replacement to obtain a fresh one.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

The requested webhook endpoint.

apiVersion
string | null
required
createdAt
string
required
description
string | null
required
id
string
required
metadata
unknown
required
status
enum<string>
required
Available options:
enabled,
errored,
disabled,
deleted
subscribedEvents
enum<string>[]
required
Available options:
*,
customer.*,
transfer.*,
document.*,
service.*,
customer.created,
customer.pending,
customer.approved,
customer.rejected,
transfer.created,
transfer.pendingFunding,
transfer.pendingReview,
transfer.fundsReceived,
transfer.processing,
transfer.succeeded,
transfer.returned,
transfer.pendingRefundInformation,
transfer.failed,
transfer.canceled,
transfer.refunded,
transfer.unexpectedError,
transfer.failedPrecondition,
transfer.expired,
transfer.unfunded,
document.pending,
document.processing,
document.verified,
document.rejected,
service.pending,
service.processing,
service.succeeded,
service.failed,
service.cancelled
updatedAt
string
required
url
string
required
Last modified on August 27, 2026