v2

latestOpenAPI 3.1.02026-07-26102336742.6 KB

Newsletter Events

Newsletter Subscribed

Fired when someone subscribes to the newsletter.

postWebhookNEWSLETTER_SUBSCRIBED

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": "NEWSLETTER_SUBSCRIBED",
  "apiVersion": "V1",
  "createdAt": "2020-08-13T09:05:36.939+00:00"
}

Response

Event received successfully