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

API version date string this endpoint was configured with, or null if not set.

Example:

"2026-04-01"

createdAt
string
required

ISO 8601 timestamp when the endpoint was created.

Example:

"2026-01-01T00:00:00.000Z"

description
string | null
required

Human-readable description of this webhook endpoint, or null if not set.

Example:

"Production payment events handler"

id
string
required

The unique identifier of the webhook endpoint.

Example:

"webhook_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"

metadata
any | null
required

Arbitrary key-value metadata attached to this endpoint, or null if not set.

Example:
status
enum<string>
required

The current state of this endpoint.

Available options:
enabled,
errored,
disabled,
deleted
Example:

"enabled"

subscribedEvents
enum<string>[]
required

List of event types this endpoint receives.

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
Example:
updatedAt
string
required

ISO 8601 timestamp when the endpoint was last updated.

Example:

"2026-01-01T00:00:00.000Z"

url
string
required

The HTTPS URL events are delivered to.

Example:

"https://example.com/webhooks/sphere"

Last modified on August 27, 2026