Skip to main content
POST
Send or schedule an alert

Authorizations

Authorization
string
header
required

An API key created by the chain owner in the panel (Integrações → Nova chave), sent as Authorization: Bearer <key>. The key (<id>|na_…) is shown once, at creation; rotate or revoke it on the same screen. It is a server secret: never ship it in browser or mobile code.

Headers

Idempotency-Key
string

Makes the request safe to retry. Send a value unique to this intended operation — a UUID v4 is recommended. The first response, a success or a business-rule refusal (any error with its own code, including dispatch_in_progress and dispatch_too_soon), is stored for 24 hours and replayed to a repetition with the same key and body, byte for byte and with its original Content-Language, under Idempotent-Replayed: true. A stored refusal is not retried: to try again for real, send a new key. validation_failed, forbidden and server errors are not stored. The same key with a different body is a 422 idempotency_key_reused; a repetition while the first request still runs is a 409 idempotency_request_in_progress. A replay counts towards the rate limit.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]{1,255}$
Accept-Language
enum<string>

Language of message and of translated content such as item names (pt-BR or en). Without it, the chain's default language.

Available options:
pt-BR,
en
X-Request-Id
string

Your own correlation id (1–64 characters of A-Za-z0-9._-), echoed back; generated when absent. Quote it to support.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9._-]{1,64}$

Path Parameters

establishment
integer
required

The establishment ID

item
integer
required

The item ID

Body

application/json
message
string
required
Maximum string length: 200
title
string | null
Maximum string length: 120
scheduled_at
string<date-time> | null

Response

Event

data
Event · object
required