Skip to main content
POST
onRemittanceEvent

Body

application/json

Details that are sent over to the webhook

id
string
required

The unique identifier for the event.

createdAt
string<date-time>
required

The timestamp when the event was created.

updatedAt
string<date-time>
required

The timestamp when the event was last updated.

status
string
required

The status of the event (e.g., pending, succeeded, sync_error).

operation
string
required

The operation that triggered the event (e.g., INSERT, UPDATE, DELETE).

trigger
string
required

The trigger that caused the event (e.g., update.remittance.status.sync_error).

payload
object
required

The payload of the event, containing the remittance data.

table
string
required

The name of the table associated with the event (e.g., remittances).

webhookSubscriptionId
string
required

The ID of the webhook subscription that triggered this event.

resourceId
string
required

The ID of the resource affected by the event.

retries
object[]
required

Array of retry attempts for this event.

scheduledAt
string<date-time> | null

The timestamp when the event is scheduled to be processed.

processedAt
string<date-time> | null

The timestamp when the event was processed.

retryOfId
string | null

The ID of the event this is a retry of, if applicable.

Response

200

Return a 200 status to indicate that the data was received successfully