Skip to main content
GET
Retrieve a webhook event

Authorizations

X-API-Key
string
header
required

A Modulus API key with the required webhook scope.

Path Parameters

event_id
string<uuid>
required

Webhook event identifier returned by the event list operation.

Response

Event and canonical payload retrieved.

id
string<uuid>
required

Unique webhook event identifier. Use it to retrieve or retrigger this event.

type
enum<string>
required

Payment event type.

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

Receiver submission status. SUBMITTED means accepted for delivery, not confirmed merchant receipt.

Available options:
PENDING,
SUBMITTING,
SUBMIT_FAILED,
SUBMITTED,
DELIVERED,
EXHAUSTED,
NOT_SUBSCRIBED
created_at
string<date-time>
required

UTC RFC 3339 timestamp when the webhook event was created.

data
object
required

Persisted canonical event data. The signed delivery envelope adds id, type, and created_at.