TANITARDevelopers
WebhooksEvent catalogevent

event.ticket.payment-link-email-status-changed

Version 1 of the event.ticket.payment-link-email-status-changed webhook event.

The event.ticket.payment-link-email-status-changed event.

Event typeevent.ticket.payment-link-email-status-changed
Schema version1
Routing keyevent.event.ticket.payment-link-email-status-changed.v1
Produced bynotification-service
Schemaurn:defendr:contract:event:ticket-payment-link-email-status-changed:1

data fields

FieldTypeRequiredDescription
eventIdstringyes
deliveryIdstringyes
status"pending", "sending", "smtp-accepted", "missing-contact", "failed", "expired", "revoked"yes
attemptsintegeryes
revisionintegeryes
orderIdstringyes
deliveryKind"payment-link"yes

Some fields are required only in particular states. The JSON Schema below is authoritative.

Example delivery

Signed with the example secret whsec_placeholder_example_webhooks_signing_secret, so you can check your verifier against it. See Verifying signatures.

POST /your/webhook/endpoint HTTP/1.1
content-type: application/json
webhook-id: whd_00000000-0000-4000-8000-000000000012
webhook-timestamp: 1800000000
webhook-signature: v1,nDLWzRNXWd0/FMeCJO2qyxLyHzeSEPs0a8cEB3L1ySI=
tanitar-event-type: event.ticket.payment-link-email-status-changed
tanitar-schema-version: 1
tanitar-delivery-attempt: 1

{"messageId":"evt_00000000-0000-4000-8000-000000000012","kind":"event","type":"event.ticket.payment-link-email-status-changed","schemaVersion":1,"occurredAt":"2027-01-15T10:00:00.000Z","producer":"notification-service","accountId":"acc_11111111-1111-4111-8111-111111111111","correlationId":"corr_00000000-0000-4000-8000-000000000012","data":{"eventId":"event_example","orderId":"ticket_order_example","deliveryId":"ticket-payment-link:example","deliveryKind":"payment-link","status":"smtp-accepted","attempts":1,"revision":1}}

The same body, formatted:

{
  "messageId": "evt_00000000-0000-4000-8000-000000000012",
  "kind": "event",
  "type": "event.ticket.payment-link-email-status-changed",
  "schemaVersion": 1,
  "occurredAt": "2027-01-15T10:00:00.000Z",
  "producer": "notification-service",
  "accountId": "acc_11111111-1111-4111-8111-111111111111",
  "correlationId": "corr_00000000-0000-4000-8000-000000000012",
  "data": {
    "eventId": "event_example",
    "orderId": "ticket_order_example",
    "deliveryId": "ticket-payment-link:example",
    "deliveryKind": "payment-link",
    "status": "smtp-accepted",
    "attempts": 1,
    "revision": 1
  }
}

JSON Schema

urn:defendr:contract:event:ticket-payment-link-email-status-changed:1
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "urn:defendr:contract:event:ticket-payment-link-email-status-changed:1",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "eventId",
    "deliveryId",
    "status",
    "attempts",
    "revision",
    "orderId",
    "deliveryKind"
  ],
  "properties": {
    "eventId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 400
    },
    "deliveryId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 400
    },
    "status": {
      "enum": [
        "pending",
        "sending",
        "smtp-accepted",
        "missing-contact",
        "failed",
        "expired",
        "revoked"
      ]
    },
    "attempts": {
      "type": "integer",
      "minimum": 0,
      "maximum": 5
    },
    "revision": {
      "type": "integer",
      "minimum": 1
    },
    "orderId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 400
    },
    "deliveryKind": {
      "const": "payment-link"
    }
  }
}

On this page