API Reference

Service that allows different events to be sent to the merchant.

Log in to see full request history
Body Params

A JSON structure will be sent that will have the information about the event to notify the merchant.

string
required
length ≤ 128

Set of events that the merchant can receive.

Possible values:

  • order.pay - Event notification when an order has been successfully paid by the buyer.
string
required

Event data.

Possible values:

  • The Order object is to be received when the order.pay event is notified.
Headers
string
required

Unique message identifier for the webhook message. This identifier is unique across all messages, but will be the same when the same webhook is forwarded (for example, due to a previous error).

string
required

Date and time when the webhook is sent to the merchant, in milliseconds and UTC format.

The Unix epoch (or Unix time or POSIX time or Unix timestamp) is the number of seconds elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap seconds (in ISO 8601: 1970-01-01T00: 00:00Z)

string
required

Base64 encoded signature (delimited by spaces) on the sent content, the signature is generated from the following structure: signed_content = "${svix_id}.${svix_timestamp}.${body}".

string
required

Content Type accepted.

Responses
200

Event received by the merchant.

500

Internal Server Error.

Language
Click Try It! to start a request and see the response here!