Sign in

v2

latestOpenAPI 3.1.02026-07-26102336742.6 KB
Order Events

Donation

Fired when a new donation is received.

postWebhookDONATION

Payload

idstring required

Unique identifier for this webhook event

webhookIdstring required

ID of the webhook configuration that triggered this event

shopIdstring required

ID of the shop that generated this event

typestring required

The event type

apiVersionstring required

API version of the webhook payload

createdAtstring date-time required

When this event was created

testModeboolean required

Whether this event was sent in test mode

Example payload

{
  "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
  "webhookId": "00aa4abd-5778-4199-8161-0b49b2f212e5",
  "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
  "type": "DONATION",
  "apiVersion": "V1",
  "createdAt": "2020-08-13T09:05:36.939+00:00",
  "data": {
    "id": "don_Kpcjx4HIQ1e4bTIOjX9CsA",
    "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
    "email": "supporter@fourthwall.com",
    "username": "Johnny123",
    "message": "Sample message",
    "amounts": {
      "total": {
        "value": 10,
        "currency": "USD"
      }
    },
    "createdAt": "2020-08-13T09:05:36.939Z",
    "updatedAt": "2020-08-13T09:05:36.939Z"
  }
}

Response

Event received successfully