Skip to main content
GET
Get Webhook

Authorizations

Authorization
string
header
required

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

Path Parameters

webhookId
string<uuid>
required

Webhook identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Webhook

webhookId
string<uuid>
required

Webhook identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

externalProvider
string
required

External provider name

Example:

"in_memory"

externalEventId
string
required

External provider webhook event identifier

Example:

"hook_123"

externalEventType
string
required

External provider webhook event type

Example:

"charge.paid"

actionType
enum<string>
required

Persisted internal webhook action type

Available options:
UPDATE_PAYMENT,
PAYMENT_PAID,
UPDATE_ORDER,
UPDATE_TRANSFER
Example:

"PAYMENT_PAID"

payload
object
required

Original provider webhook payload

Example:
status
enum<string>
required

Webhook processing status

Available options:
RECEIVED,
PROCESSED,
FAILED
Example:

"PROCESSED"

receivedCount
integer
required

Number of provider deliveries for this event

Example:

2

createdAt
string<date-time>
required

Creation timestamp

Example:

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

lastReceivedAt
string<date-time>
required

Last provider delivery timestamp

Example:

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

updatedAt
string<date-time>
required

Last update timestamp

Example:

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

error
string | null

Webhook processing error

Example:

"Payment not found"

createdBy
string<uuid> | null

Created by

Example:

null

updatedBy
string<uuid> | null

Updated by

Example:

null

processedAt
string<date-time> | null

Webhook processed timestamp

Example:

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