• Consents
  • External Messages
  • Transactional messaging

    • Transactional messaging

    Publish transactional messaging triggers and look up the triggers and messages they produce. Covers internal and externally-defined triggers, plus reading the resulting message delivery status.

    Endpoints

    • publishtransactionalmessagingtrigger

      Publish an internally-defined trigger within the transactional messaging service. Validates the trigger type code and params.

      Fields: trigger, trigger.id, trigger.triggerTypeCode, trigger.createdAt, trigger.processingStatus
    • publishtransactionalmessagingexternaltrigger

      Publish an externally-defined trigger. Supports account, account-user or non-account recipients, template variables and an idempotency key.

      Fields: trigger, trigger.id, trigger.triggerTypeCode, trigger.createdAt, trigger.processingStatus
    • trigger

      Get the details of a published trigger by its ID.

      Fields: id, triggerTypeCode, createdAt, accountsLinkedAt, processingStatus
    • message

      Get the details of a transactional message by its external ID.

      Fields: channel, dispatchedAt, failedAt, deliveredAt, id