Skip to main content
POST
/
v1
/
events
/
send
Disparar evento (cria runs)
curl --request POST \
  --url https://api.notifique.dev/v1/events/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event": "<string>",
  "payload": {},
  "contactId": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>"
}
'
{
  "success": true,
  "data": {
    "runs": [
      {
        "runId": "clrunxxxxxxxxxxxxxxxxx",
        "automationId": "clautyyyyyyyyyyyyyyyyy"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Authorization: Bearer sk_live_...

Headers

Idempotency-Key
string

Chave única por disparo lógico no workspace.

Maximum string length: 256

Body

application/json

Exatamente um entre contactId, email, phone deve ser enviado.

event
string
required

Nome igual ao cadastro em POST /v1/events.

Maximum string length: 256
payload
object

Objeto; campos obrigatórios e tipos vêm de schemaJson.

contactId
string

Mutuamente exclusivo com email/phone.

email
string<email>
phone
string

E.164 recomendado (ex.: +5511999990000).

Response

Disparo aceito. runs pode ser vazio; idempotentReplay quando a mesma Idempotency-Key já foi processada.

success
enum<boolean>
required
Available options:
true
data
object
required