Skip to main content
GET
Retrieve a webhook endpoint

Authorizations

X-API-Key
string
header
required

A Modulus API key with the required webhook scope.

Path Parameters

id
string<uuid>
required

Webhook endpoint identifier returned by the create operation.

Response

Endpoint retrieved.

id
string<uuid>
required

Unique webhook endpoint identifier.

url
string<uri>
required

Public HTTPS callback URL that receives subscribed events.

enabled_events
enum<string>[]
required

Payment event types currently delivered to this endpoint.

Payment event type delivered to a subscribed endpoint.

Available options:
payment.succeeded,
payment.declined,
payment.failed,
payment.expired
status
enum<string>
required

Delivery state of the endpoint.

Available options:
ENABLED,
DISABLED
metadata
object
required

Merchant-owned endpoint metadata. This is endpoint configuration and is not payment-event metadata.

created_at
string<date-time>
required

UTC RFC 3339 timestamp when the endpoint was created.

updated_at
string<date-time>
required

UTC RFC 3339 timestamp when the endpoint was last updated.

description
string | null

Merchant-defined endpoint label, or null when none was supplied.