Skip to content

Marketing consent created
Alpha
Webhook

Request

Sent when a new marketing consent is submitted.

This webhook is triggered every time a consent is submitted, even if the email already exists. This allows external marketing systems to resubscribe users who may have been unsubscribed externally.

Headers
webhook-idstringrequired

Unique identifier for this webhook message. This ID is the same when a webhook is retried due to a previous failure. Use this for deduplication.

webhook-timestampstringrequired

Timestamp of when the webhook was sent, in seconds since epoch. Compare against your system time to prevent replay attacks.

webhook-signaturestringrequired

Base64-encoded HMAC-SHA256 signature for verifying the webhook authenticity. The signature is computed over: {webhook-id}.{webhook-timestamp}.{body}.

Bodyapplication/jsonrequired

Information about the marketing consent.

idstringrequired

Unique identifier for the event.

typestringrequired

The event type.

Value:"v1.marketing_consent.created"
timestampstring, (date-time)required

Timestamp of when the event occurred.

payloadobject(MarketingConsentCreatedEventV1)required

The event-specific payload data.

POST
v1.marketing_consent.created
Payload
{
  "id": "string",
  "type": "v1.marketing_consent.created",
  "timestamp": "2019-08-24T14:15:22Z",
  "payload": {
    "company_id": "string",
    "consent_id": "string"
  }
}

Responses

OK