Listar notificações
RegistosGET /notification-intents
Message rendering and channel delivery are performed externally.
Parâmetros
limitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
event_typeExact event type that produced the intent; returns only intents with this event type.
Devolve
200 Utility-scoped notification intents
Mostrar atributos
dataMostrar atributos filhos
idtenant_idevent_typerecipient_typerecipient_idresource_typeresource_idinbox_titleOptional in-app message title; requires inbox_body and a consumer or staff recipient.
inbox_bodyOptional in-app message body; requires inbox_title and a consumer or staff recipient.
datatemplate_keyOptional approved template identifier; not channel-specific content.
delivery_planDurable outbound channel order and rendered message content. Recipients must contain a non-empty destination for every listed channel.
Mostrar atributos filhos
channelsrecipientssubjecttexthtml
categoryNotification category used for recipient policy.
priorityum de
critical,high,normal,lowlocaleRecipient locale captured when the intent was created; defaults to pt-MZ.
um de
pt-MZ,en-USscheduled_atNext allowed delivery time after recipient quiet hours; urgent categories are not delayed.
statusum de
pending,accepted,sent,delivered,faileddeliveryMostrar atributos filhos
idtenant_idintent_idchannelum de
email,push,in_appstatusum de
pending,leased,accepted,sent,delivered,failedattemptprovider_receipt_referencefailure_codefailure_reasonattemptsMostrar atributos filhos
numberchannelum de
email,push,in_appstatusum de
pending,leased,accepted,sent,delivered,failedprovider_receipt_referencefailure_codefailure_reasonidempotency_keycreated_at
idempotency_keycreated_atupdated_atavailable_at
has_morenext_cursortotal_count
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_..."
# Sem comando CLI equivalente; use cURL ou HTTP directo.
const res = await fetch("$BUSINESS_API/notification-intents", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/notification-intents",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/notification-intents", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"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
}