Notification intents

Base URL: $BUSINESS_API

The object

idstring · required
tenant_idstring · required
event_typestring · required
recipient_typestring · required
recipient_idstring · required
resource_typestring · required
resource_idstring · required
inbox_titlestring · optional

Optional in-app message title; requires inbox_body and a consumer or staff recipient.

inbox_bodystring · optional

Optional in-app message body; requires inbox_title and a consumer or staff recipient.

dataobject · optional
template_keystring · optional

Optional approved template identifier; not channel-specific content.

delivery_planobject · optional

Durable outbound channel order and rendered message content. Recipients must contain a non-empty destination for every listed channel.

Show child attributes
channelsarray of string · required
recipientsobject · required
subjectstring · optional
textstring · required
htmlstring · optional
categorystring · optional

Notification category used for recipient policy.

prioritystring · optional

one of critical, high, normal, low

localestring · required

Recipient locale captured when the intent was created; defaults to pt-MZ.

one of pt-MZ, en-US

scheduled_atstring (date-time) · optional

Next allowed delivery time after recipient quiet hours; urgent categories are not delayed.

statusstring · required

one of pending, accepted, sent, delivered, failed

deliveryobject · optional
Show child attributes
idstring · required
tenant_idstring · required
intent_idstring · required
channelstring · optional

one of email, push, in_app

statusstring · required

one of pending, leased, accepted, sent, delivered, failed

attemptinteger · required
provider_receipt_referencestring · optional
failure_codestring · optional
failure_reasonstring · optional
attemptsarray of object · optional
Show child attributes
numberinteger · required
channelstring · required

one of email, push, in_app

statusstring · required

one of pending, leased, accepted, sent, delivered, failed

provider_receipt_referencestring · optional
failure_codestring · optional
failure_reasonstring · optional
idempotency_keystring · required
created_atstring (date-time) · required
idempotency_keystring · required
created_atstring (date-time) · required
updated_atstring (date-time) · required
available_atstring (date-time) · optional
The object
{
  "id": "not_2Ymr9A6b36EnlgGBvymhjsEXxyg",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "event_type": "invoice.issued",
  "recipient_type": "recipient type",
  "recipient_id": "rec_2Fj2I5VC2F9MUXfa4XBWM39egPf",
  "resource_type": "resource type",
  "resource_id": "res_2iAXhMsJzmqPnY6X5cMTJ6OBTSG",
  "inbox_title": "inbox title",
  "inbox_body": "inbox body",
  "data": {},
  "template_key": "template key",
  "delivery_plan": {
    "channels": [
      "email"
    ],
    "recipients": {
      "key": "value"
    },
    "subject": "Fuga na Rua 3",
    "text": "text",
    "html": "html"
  },
  "category": "category",
  "priority": "critical",
  "locale": "pt-MZ",
  "scheduled_at": "2026-11-19T09:30:00Z",
  "status": "pending",
  "delivery": {
    "id": "not_2a2XBy83j8Q9LWaD1wyBJkAlVyy",
    "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
    "intent_id": "int_22Gr1MqNzCoLNQG9VCg3dYIRdQg",
    "channel": "email",
    "status": "pending",
    "attempt": 1,
    "provider_receipt_reference": "PRO-2026-000142",
    "failure_code": "FAI-2026-000142",
    "failure_reason": "failure reason",
    "attempts": [
      {
        "number": 1,
        "channel": "email",
        "status": "pending",
        "provider_receipt_reference": "PRO-2026-000142",
        "failure_code": "FAI-2026-000142",
        "failure_reason": "failure reason",
        "idempotency_key": "idempotency key",
        "created_at": "2026-11-19T09:30:00Z"
      }
    ],
    "idempotency_key": "idempotency key",
    "created_at": "2026-11-19T09:30:00Z",
    "updated_at": "2026-11-19T09:30:00Z",
    "available_at": "2026-11-19T09:30:00Z"
  }
}

List durable business notification intents

Logs

GET /notification-intents

Message rendering and channel delivery are performed externally.

Parameters

limitinteger · query · optional

Maximum resources to return (default 20, maximum 100).

afterstring · query · optional

Opaque cursor returned by the previous page.

event_typestring · query · optional

Exact event type that produced the intent; returns only intents with this event type.

Returns

200 Utility-scoped notification intents

Show attributes
dataarray of NotificationIntent · required
Show child attributes
idstring · required
tenant_idstring · required
event_typestring · required
recipient_typestring · required
recipient_idstring · required
resource_typestring · required
resource_idstring · required
inbox_titlestring · optional

Optional in-app message title; requires inbox_body and a consumer or staff recipient.

inbox_bodystring · optional

Optional in-app message body; requires inbox_title and a consumer or staff recipient.

dataobject · optional
template_keystring · optional

Optional approved template identifier; not channel-specific content.

delivery_planobject · optional

Durable outbound channel order and rendered message content. Recipients must contain a non-empty destination for every listed channel.

Show child attributes
channelsarray of string · required
recipientsobject · required
subjectstring · optional
textstring · required
htmlstring · optional
categorystring · optional

Notification category used for recipient policy.

prioritystring · optional

one of critical, high, normal, low

localestring · required

Recipient locale captured when the intent was created; defaults to pt-MZ.

one of pt-MZ, en-US

scheduled_atstring (date-time) · optional

Next allowed delivery time after recipient quiet hours; urgent categories are not delayed.

statusstring · required

one of pending, accepted, sent, delivered, failed

deliveryobject · optional
Show child attributes
idstring · required
tenant_idstring · required
intent_idstring · required
channelstring · optional

one of email, push, in_app

statusstring · required

one of pending, leased, accepted, sent, delivered, failed

attemptinteger · required
provider_receipt_referencestring · optional
failure_codestring · optional
failure_reasonstring · optional
attemptsarray of object · optional
Show child attributes
numberinteger · required
channelstring · required

one of email, push, in_app

statusstring · required

one of pending, leased, accepted, sent, delivered, failed

provider_receipt_referencestring · optional
failure_codestring · optional
failure_reasonstring · optional
idempotency_keystring · required
created_atstring (date-time) · required
idempotency_keystring · required
created_atstring (date-time) · required
updated_atstring (date-time) · required
available_atstring (date-time) · optional
has_moreboolean · required
next_cursorstring · optional
total_countinteger · optional

Errors 403

Permissions business:notification-intents:read · Roles: admin, customer_service, owner

curl -X GET "$BUSINESS_API/notification-intents" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "data": [
    {
      "id": "not_2Ymr9A6b36EnlgGBvymhjsEXxyg",
      "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
      "event_type": "invoice.issued",
      "recipient_type": "recipient type",
      "recipient_id": "rec_2Fj2I5VC2F9MUXfa4XBWM39egPf",
      "resource_type": "resource type",
      "resource_id": "res_2iAXhMsJzmqPnY6X5cMTJ6OBTSG",
      "inbox_title": "inbox title",
      "inbox_body": "inbox body",
      "data": {},
      "template_key": "template key",
      "delivery_plan": {
        "channels": [
          "email"
        ],
        "recipients": {
          "key": "value"
        },
        "subject": "Fuga na Rua 3",
        "text": "text",
        "html": "html"
      },
      "category": "category",
      "priority": "critical",
      "locale": "pt-MZ",
      "scheduled_at": "2026-11-19T09:30:00Z",
      "status": "pending",
      "delivery": {
        "id": "not_2a2XBy83j8Q9LWaD1wyBJkAlVyy",
        "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
        "intent_id": "int_22Gr1MqNzCoLNQG9VCg3dYIRdQg",
        "channel": "email",
        "status": "pending",
        "attempt": 1,
        "provider_receipt_reference": "PRO-2026-000142",
        "failure_code": "FAI-2026-000142",
        "failure_reason": "failure reason",
        "attempts": [
          {
            "number": 1,
            "channel": "email",
            "status": "pending",
            "provider_receipt_reference": "PRO-2026-000142",
            "failure_code": "FAI-2026-000142",
            "failure_reason": "failure reason",
            "idempotency_key": "idempotency key",
            "created_at": "2026-11-19T09:30:00Z"
          }
        ],
        "idempotency_key": "idempotency key",
        "created_at": "2026-11-19T09:30:00Z",
        "updated_at": "2026-11-19T09:30:00Z",
        "available_at": "2026-11-19T09:30:00Z"
      }
    }
  ],
  "has_more": true,
  "next_cursor": "next cursor",
  "total_count": 125000
}

Queue a recipient notification intent

Logs

POST /notification-intents

Captures the recipient's preferred locale at creation time; message rendering and channel delivery are performed externally.

Body application/json

event_typestring · required
recipient_typestring · required
recipient_idstring · required
resource_typestring · optional
resource_idstring · optional
inbox_titlestring · optional

Optional in-app message title; requires inbox_body and a consumer or staff recipient.

inbox_bodystring · optional

Optional in-app message body; requires inbox_title and a consumer or staff recipient.

dataobject · optional
template_keystring · optional

Optional approved template identifier; not channel-specific content.

delivery_planobject · optional

Durable outbound channel order and rendered message content. Recipients must contain a non-empty destination for every listed channel.

Show child attributes
channelsarray of string · required
recipientsobject · required
subjectstring · optional
textstring · required
htmlstring · optional
categorystring · optional

Notification category used for quiet-hours and opt-out policy.

prioritystring · optional

one of critical, high, normal, low

idempotency_keystring · required

Returns

201 Notification intent queued

Show attributes
idstring · required
tenant_idstring · required
event_typestring · required
recipient_typestring · required
recipient_idstring · required
resource_typestring · required
resource_idstring · required
inbox_titlestring · optional

Optional in-app message title; requires inbox_body and a consumer or staff recipient.

inbox_bodystring · optional

Optional in-app message body; requires inbox_title and a consumer or staff recipient.

dataobject · optional
template_keystring · optional

Optional approved template identifier; not channel-specific content.

delivery_planobject · optional

Durable outbound channel order and rendered message content. Recipients must contain a non-empty destination for every listed channel.

Show child attributes
channelsarray of string · required
recipientsobject · required
subjectstring · optional
textstring · required
htmlstring · optional
categorystring · optional

Notification category used for recipient policy.

prioritystring · optional

one of critical, high, normal, low

localestring · required

Recipient locale captured when the intent was created; defaults to pt-MZ.

one of pt-MZ, en-US

scheduled_atstring (date-time) · optional

Next allowed delivery time after recipient quiet hours; urgent categories are not delayed.

statusstring · required

one of pending, accepted, sent, delivered, failed

deliveryobject · optional
Show child attributes
idstring · required
tenant_idstring · required
intent_idstring · required
channelstring · optional

one of email, push, in_app

statusstring · required

one of pending, leased, accepted, sent, delivered, failed

attemptinteger · required
provider_receipt_referencestring · optional
failure_codestring · optional
failure_reasonstring · optional
attemptsarray of object · optional
Show child attributes
numberinteger · required
channelstring · required

one of email, push, in_app

statusstring · required

one of pending, leased, accepted, sent, delivered, failed

provider_receipt_referencestring · optional
failure_codestring · optional
failure_reasonstring · optional
idempotency_keystring · required
created_atstring (date-time) · required
idempotency_keystring · required
created_atstring (date-time) · required
updated_atstring (date-time) · required
available_atstring (date-time) · optional

Errors 400 · 403

Permissions business:notification-intents:create · Roles: admin, customer_service, owner

curl -X POST "$BUSINESS_API/notification-intents" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "event_type": "event type",
  "recipient_type": "recipient type",
  "recipient_id": "rec_2Fj2I5VC2F9MUXfa4XBWM39egPf",
  "resource_type": "resource type",
  "resource_id": "res_2iAXhMsJzmqPnY6X5cMTJ6OBTSG",
  "inbox_title": "inbox title",
  "inbox_body": "inbox body",
  "data": {},
  "template_key": "template key",
  "delivery_plan": {
    "channels": [
      "email"
    ],
    "recipients": {
      "key": "value"
    },
    "subject": "Fuga na Rua 3",
    "text": "text",
    "html": "html"
  },
  "category": "category",
  "priority": "critical",
  "idempotency_key": "idempotency key"
}'
Response 201
{
  "id": "not_2Ymr9A6b36EnlgGBvymhjsEXxyg",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "event_type": "invoice.issued",
  "recipient_type": "recipient type",
  "recipient_id": "rec_2Fj2I5VC2F9MUXfa4XBWM39egPf",
  "resource_type": "resource type",
  "resource_id": "res_2iAXhMsJzmqPnY6X5cMTJ6OBTSG",
  "inbox_title": "inbox title",
  "inbox_body": "inbox body",
  "data": {},
  "template_key": "template key",
  "delivery_plan": {
    "channels": [
      "email"
    ],
    "recipients": {
      "key": "value"
    },
    "subject": "Fuga na Rua 3",
    "text": "text",
    "html": "html"
  },
  "category": "category",
  "priority": "critical",
  "locale": "pt-MZ",
  "scheduled_at": "2026-11-19T09:30:00Z",
  "status": "pending",
  "delivery": {
    "id": "not_2a2XBy83j8Q9LWaD1wyBJkAlVyy",
    "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
    "intent_id": "int_22Gr1MqNzCoLNQG9VCg3dYIRdQg",
    "channel": "email",
    "status": "pending",
    "attempt": 1,
    "provider_receipt_reference": "PRO-2026-000142",
    "failure_code": "FAI-2026-000142",
    "failure_reason": "failure reason",
    "attempts": [
      {
        "number": 1,
        "channel": "email",
        "status": "pending",
        "provider_receipt_reference": "PRO-2026-000142",
        "failure_code": "FAI-2026-000142",
        "failure_reason": "failure reason",
        "idempotency_key": "idempotency key",
        "created_at": "2026-11-19T09:30:00Z"
      }
    ],
    "idempotency_key": "idempotency key",
    "created_at": "2026-11-19T09:30:00Z",
    "updated_at": "2026-11-19T09:30:00Z",
    "available_at": "2026-11-19T09:30:00Z"
  }
}

Get a notification intent

Logs

GET /notification-intents/{id}

Returns one notification intent with its event type, recipient, related resource, inbox text, template, delivery plan, status and, when present, its delivery. Returns 404 when the intent does not exist in the caller's tenant. Requires the business:notification-intents:read permission.

Parameters

idstring · path · required

ID of the notification intent in the caller's tenant.

Returns

200 Utility-scoped notification intent

Show attributes
idstring · required
tenant_idstring · required
event_typestring · required
recipient_typestring · required
recipient_idstring · required
resource_typestring · required
resource_idstring · required
inbox_titlestring · optional

Optional in-app message title; requires inbox_body and a consumer or staff recipient.

inbox_bodystring · optional

Optional in-app message body; requires inbox_title and a consumer or staff recipient.

dataobject · optional
template_keystring · optional

Optional approved template identifier; not channel-specific content.

delivery_planobject · optional

Durable outbound channel order and rendered message content. Recipients must contain a non-empty destination for every listed channel.

Show child attributes
channelsarray of string · required
recipientsobject · required
subjectstring · optional
textstring · required
htmlstring · optional
categorystring · optional

Notification category used for recipient policy.

prioritystring · optional

one of critical, high, normal, low

localestring · required

Recipient locale captured when the intent was created; defaults to pt-MZ.

one of pt-MZ, en-US

scheduled_atstring (date-time) · optional

Next allowed delivery time after recipient quiet hours; urgent categories are not delayed.

statusstring · required

one of pending, accepted, sent, delivered, failed

deliveryobject · optional
Show child attributes
idstring · required
tenant_idstring · required
intent_idstring · required
channelstring · optional

one of email, push, in_app

statusstring · required

one of pending, leased, accepted, sent, delivered, failed

attemptinteger · required
provider_receipt_referencestring · optional
failure_codestring · optional
failure_reasonstring · optional
attemptsarray of object · optional
Show child attributes
numberinteger · required
channelstring · required

one of email, push, in_app

statusstring · required

one of pending, leased, accepted, sent, delivered, failed

provider_receipt_referencestring · optional
failure_codestring · optional
failure_reasonstring · optional
idempotency_keystring · required
created_atstring (date-time) · required
idempotency_keystring · required
created_atstring (date-time) · required
updated_atstring (date-time) · required
available_atstring (date-time) · optional

Errors 403 · 404

Permissions business:notification-intents:read · Roles: admin, customer_service, owner

curl -X GET "$BUSINESS_API/notification-intents/{id}" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "id": "not_2Ymr9A6b36EnlgGBvymhjsEXxyg",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "event_type": "invoice.issued",
  "recipient_type": "recipient type",
  "recipient_id": "rec_2Fj2I5VC2F9MUXfa4XBWM39egPf",
  "resource_type": "resource type",
  "resource_id": "res_2iAXhMsJzmqPnY6X5cMTJ6OBTSG",
  "inbox_title": "inbox title",
  "inbox_body": "inbox body",
  "data": {},
  "template_key": "template key",
  "delivery_plan": {
    "channels": [
      "email"
    ],
    "recipients": {
      "key": "value"
    },
    "subject": "Fuga na Rua 3",
    "text": "text",
    "html": "html"
  },
  "category": "category",
  "priority": "critical",
  "locale": "pt-MZ",
  "scheduled_at": "2026-11-19T09:30:00Z",
  "status": "pending",
  "delivery": {
    "id": "not_2a2XBy83j8Q9LWaD1wyBJkAlVyy",
    "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
    "intent_id": "int_22Gr1MqNzCoLNQG9VCg3dYIRdQg",
    "channel": "email",
    "status": "pending",
    "attempt": 1,
    "provider_receipt_reference": "PRO-2026-000142",
    "failure_code": "FAI-2026-000142",
    "failure_reason": "failure reason",
    "attempts": [
      {
        "number": 1,
        "channel": "email",
        "status": "pending",
        "provider_receipt_reference": "PRO-2026-000142",
        "failure_code": "FAI-2026-000142",
        "failure_reason": "failure reason",
        "idempotency_key": "idempotency key",
        "created_at": "2026-11-19T09:30:00Z"
      }
    ],
    "idempotency_key": "idempotency key",
    "created_at": "2026-11-19T09:30:00Z",
    "updated_at": "2026-11-19T09:30:00Z",
    "available_at": "2026-11-19T09:30:00Z"
  }
}