PT EN

Notificações

URL base: $BUSINESS_API

O objecto

idstring · obrigatório
tenant_idstring · obrigatório
event_typestring · obrigatório
recipient_typestring · obrigatório
recipient_idstring · obrigatório
resource_typestring · obrigatório
resource_idstring · obrigatório
inbox_titlestring · opcional

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

inbox_bodystring · opcional

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

dataobject · opcional
template_keystring · opcional

Optional approved template identifier; not channel-specific content.

delivery_planobject · opcional

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

Mostrar atributos filhos
channelsarray of string · obrigatório
recipientsobject · obrigatório
subjectstring · opcional
textstring · obrigatório
htmlstring · opcional
categorystring · opcional

Notification category used for recipient policy.

prioritystring · opcional

um de critical, high, normal, low

localestring · obrigatório

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

um de pt-MZ, en-US

scheduled_atstring (date-time) · opcional

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

statusstring · obrigatório

um de pending, accepted, sent, delivered, failed

deliveryobject · opcional
Mostrar atributos filhos
idstring · obrigatório
tenant_idstring · obrigatório
intent_idstring · obrigatório
channelstring · opcional

um de email, push, in_app

statusstring · obrigatório

um de pending, leased, accepted, sent, delivered, failed

attemptinteger · obrigatório
provider_receipt_referencestring · opcional
failure_codestring · opcional
failure_reasonstring · opcional
attemptsarray of object · opcional
Mostrar atributos filhos
numberinteger · obrigatório
channelstring · obrigatório

um de email, push, in_app

statusstring · obrigatório

um de pending, leased, accepted, sent, delivered, failed

provider_receipt_referencestring · opcional
failure_codestring · opcional
failure_reasonstring · opcional
idempotency_keystring · obrigatório
created_atstring (date-time) · obrigatório
idempotency_keystring · obrigatório
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
available_atstring (date-time) · opcional
O objecto
{
  "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"
  }
}

Listar notificações

Registos

GET /notification-intents

Message rendering and channel delivery are performed externally.

Parâmetros

limitinteger · consulta · opcional

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

afterstring · consulta · opcional

Opaque cursor returned by the previous page.

event_typestring · consulta · opcional

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

Devolve

200 Utility-scoped notification intents

Mostrar atributos
dataarray of NotificationIntent · obrigatório
Mostrar atributos filhos
idstring · obrigatório
tenant_idstring · obrigatório
event_typestring · obrigatório
recipient_typestring · obrigatório
recipient_idstring · obrigatório
resource_typestring · obrigatório
resource_idstring · obrigatório
inbox_titlestring · opcional

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

inbox_bodystring · opcional

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

dataobject · opcional
template_keystring · opcional

Optional approved template identifier; not channel-specific content.

delivery_planobject · opcional

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

Mostrar atributos filhos
channelsarray of string · obrigatório
recipientsobject · obrigatório
subjectstring · opcional
textstring · obrigatório
htmlstring · opcional
categorystring · opcional

Notification category used for recipient policy.

prioritystring · opcional

um de critical, high, normal, low

localestring · obrigatório

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

um de pt-MZ, en-US

scheduled_atstring (date-time) · opcional

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

statusstring · obrigatório

um de pending, accepted, sent, delivered, failed

deliveryobject · opcional
Mostrar atributos filhos
idstring · obrigatório
tenant_idstring · obrigatório
intent_idstring · obrigatório
channelstring · opcional

um de email, push, in_app

statusstring · obrigatório

um de pending, leased, accepted, sent, delivered, failed

attemptinteger · obrigatório
provider_receipt_referencestring · opcional
failure_codestring · opcional
failure_reasonstring · opcional
attemptsarray of object · opcional
Mostrar atributos filhos
numberinteger · obrigatório
channelstring · obrigatório

um de email, push, in_app

statusstring · obrigatório

um de pending, leased, accepted, sent, delivered, failed

provider_receipt_referencestring · opcional
failure_codestring · opcional
failure_reasonstring · opcional
idempotency_keystring · obrigatório
created_atstring (date-time) · obrigatório
idempotency_keystring · obrigatório
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
available_atstring (date-time) · opcional
has_moreboolean · obrigatório
next_cursorstring · opcional
total_countinteger · opcional

Erros 403

Permissões business:notification-intents:read · Funções: admin, customer_service, owner

curl -X GET "$BUSINESS_API/notification-intents" \
  -H "Authorization: Bearer sk_test_..."
Resposta 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
}

Enviar uma notificação

Registos

POST /notification-intents

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

Corpo application/json

event_typestring · obrigatório
recipient_typestring · obrigatório
recipient_idstring · obrigatório
resource_typestring · opcional
resource_idstring · opcional
inbox_titlestring · opcional

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

inbox_bodystring · opcional

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

dataobject · opcional
template_keystring · opcional

Optional approved template identifier; not channel-specific content.

delivery_planobject · opcional

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

Mostrar atributos filhos
channelsarray of string · obrigatório
recipientsobject · obrigatório
subjectstring · opcional
textstring · obrigatório
htmlstring · opcional
categorystring · opcional

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

prioritystring · opcional

um de critical, high, normal, low

idempotency_keystring · obrigatório

Devolve

201 Notification intent queued

Mostrar atributos
idstring · obrigatório
tenant_idstring · obrigatório
event_typestring · obrigatório
recipient_typestring · obrigatório
recipient_idstring · obrigatório
resource_typestring · obrigatório
resource_idstring · obrigatório
inbox_titlestring · opcional

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

inbox_bodystring · opcional

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

dataobject · opcional
template_keystring · opcional

Optional approved template identifier; not channel-specific content.

delivery_planobject · opcional

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

Mostrar atributos filhos
channelsarray of string · obrigatório
recipientsobject · obrigatório
subjectstring · opcional
textstring · obrigatório
htmlstring · opcional
categorystring · opcional

Notification category used for recipient policy.

prioritystring · opcional

um de critical, high, normal, low

localestring · obrigatório

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

um de pt-MZ, en-US

scheduled_atstring (date-time) · opcional

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

statusstring · obrigatório

um de pending, accepted, sent, delivered, failed

deliveryobject · opcional
Mostrar atributos filhos
idstring · obrigatório
tenant_idstring · obrigatório
intent_idstring · obrigatório
channelstring · opcional

um de email, push, in_app

statusstring · obrigatório

um de pending, leased, accepted, sent, delivered, failed

attemptinteger · obrigatório
provider_receipt_referencestring · opcional
failure_codestring · opcional
failure_reasonstring · opcional
attemptsarray of object · opcional
Mostrar atributos filhos
numberinteger · obrigatório
channelstring · obrigatório

um de email, push, in_app

statusstring · obrigatório

um de pending, leased, accepted, sent, delivered, failed

provider_receipt_referencestring · opcional
failure_codestring · opcional
failure_reasonstring · opcional
idempotency_keystring · obrigatório
created_atstring (date-time) · obrigatório
idempotency_keystring · obrigatório
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
available_atstring (date-time) · opcional

Erros 400 · 403

Permissões business:notification-intents:create · Funções: 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"
}'
Resposta 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"
  }
}

Obter uma notificação

Registos

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.

Parâmetros

idstring · caminho · obrigatório

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

Devolve

200 Utility-scoped notification intent

Mostrar atributos
idstring · obrigatório
tenant_idstring · obrigatório
event_typestring · obrigatório
recipient_typestring · obrigatório
recipient_idstring · obrigatório
resource_typestring · obrigatório
resource_idstring · obrigatório
inbox_titlestring · opcional

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

inbox_bodystring · opcional

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

dataobject · opcional
template_keystring · opcional

Optional approved template identifier; not channel-specific content.

delivery_planobject · opcional

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

Mostrar atributos filhos
channelsarray of string · obrigatório
recipientsobject · obrigatório
subjectstring · opcional
textstring · obrigatório
htmlstring · opcional
categorystring · opcional

Notification category used for recipient policy.

prioritystring · opcional

um de critical, high, normal, low

localestring · obrigatório

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

um de pt-MZ, en-US

scheduled_atstring (date-time) · opcional

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

statusstring · obrigatório

um de pending, accepted, sent, delivered, failed

deliveryobject · opcional
Mostrar atributos filhos
idstring · obrigatório
tenant_idstring · obrigatório
intent_idstring · obrigatório
channelstring · opcional

um de email, push, in_app

statusstring · obrigatório

um de pending, leased, accepted, sent, delivered, failed

attemptinteger · obrigatório
provider_receipt_referencestring · opcional
failure_codestring · opcional
failure_reasonstring · opcional
attemptsarray of object · opcional
Mostrar atributos filhos
numberinteger · obrigatório
channelstring · obrigatório

um de email, push, in_app

statusstring · obrigatório

um de pending, leased, accepted, sent, delivered, failed

provider_receipt_referencestring · opcional
failure_codestring · opcional
failure_reasonstring · opcional
idempotency_keystring · obrigatório
created_atstring (date-time) · obrigatório
idempotency_keystring · obrigatório
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
available_atstring (date-time) · opcional

Erros 403 · 404

Permissões business:notification-intents:read · Funções: admin, customer_service, owner

curl -X GET "$BUSINESS_API/notification-intents/{id}" \
  -H "Authorization: Bearer sk_test_..."
Resposta 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"
  }
}