> ## Documentation Index > Fetch the complete documentation index at: https://docs.notifique.dev/llms.txt > Use this file to discover all available pages before exploring further. # Trigger event > Fire an event and start linked automations. ## OpenAPI ````yaml /en/automations-api/api-reference/openapi-automations.json post /v1/events/send openapi: 3.0.3 info: title: 'Notifique API v1: Automations and events' version: 1.0.0 description: >- Definition of **events** (name + optional `payload` schema), **automations** as a graph (trigger by event or **inbound message** on a channel, delays, conditions, including **`source: "message"`** on inbound, **`endFlow`** to end a branch, multi-channel sends, contact updates, etc.) and **trigger** via `POST /v1/events/send`. Auth: `Authorization: Bearer sk_live_...` or `x-api-key` header. All bodies use **camelCase**. **Scopes:** `events:read` | `events:write` | `automations:read` | `automations:write`. Send steps (`sendTemplate`, direct emails, etc.) still require the matching channel send keys. **Pagination:** query `page` (≥1, default 1) and `limit` (1 to 100, default 20), as strings or coherent numbers. **Blocked workspace** returns **402** with `Payment Required`. **Onboarding:** on any `/v1` route, if onboarding is incomplete, middleware returns **403** with `code: ONBOARDING_REQUIRED` (body similar to other 403s). servers: - url: https://api.notifique.dev description: Production security: - ntfAutoBearerAuth: [] - ntfAutoApiKeyHeader: [] tags: - name: Eventos description: CRUD de definições de evento + disparo `POST /v1/events/send`. - name: Automações description: CRUD de automações, stop e listagem de runs. - name: Runs description: Histórico e detalhe de execuções (`AutomationRun` + passos). paths: /v1/events/send: post: tags: - Eventos summary: Trigger event description: Fire an event and start linked automations. operationId: ntfAuto_sendEvent parameters: - name: Idempotency-Key in: header required: false schema: type: string maxLength: 256 description: Chave única por disparo lógico no workspace. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/NtfAuto_EventSendBody' responses: '200': $ref: '#/components/responses/NtfAuto_EventSend200' '400': $ref: '#/components/responses/NtfAuto_EventSend400' '401': $ref: '#/components/responses/NtfAuto_401' '402': $ref: '#/components/responses/NtfAuto_402' '403': $ref: '#/components/responses/NtfAuto_403EventsWrite' '404': $ref: '#/components/responses/NtfAuto_EventSend404' components: schemas: NtfAuto_EventSendBody: type: object required: - event properties: event: type: string maxLength: 256 description: Nome igual ao cadastro em `POST /v1/events`. payload: type: object additionalProperties: true description: Objeto; campos obrigatórios e tipos vêm de `schemaJson`. contactId: type: string description: Mutuamente exclusivo com email/phone. email: type: string format: email phone: type: string description: 'E.164 recomendado (ex.: +5511999990000).' description: Exatamente **um** entre `contactId`, `email`, `phone` deve ser enviado. NtfAuto_EventSendResponse: type: object required: - success - data properties: success: type: boolean enum: - true data: type: object required: - runs properties: runs: type: array items: type: object required: - runId - automationId properties: runId: type: string automationId: type: string idempotentReplay: type: boolean description: Presente quando a resposta veio de cache de idempotência. NtfAuto_ErrorSend400: type: object required: - success - error properties: success: type: boolean enum: - false error: type: string description: Mensagem humana (pode repetir o sentido de `code`). code: type: string enum: - RESERVED_EVENT - RECIPIENT_REQUIRED - INVALID_PAYLOAD - MISSING_PAYLOAD_FIELD - PAYLOAD_TYPE_MISMATCH - EVENT_NOT_DEFINED - CONTACT_NOT_FOUND - INVALID_EVENT_SCHEMA NtfAuto_ErrorEnvelope401: type: object required: - success - error - message properties: success: type: boolean enum: - false error: type: string example: Unauthorized message: type: string NtfAuto_ErrorPaymentRequired: type: object required: - success - error - message properties: success: type: boolean enum: - false error: type: string enum: - Payment Required message: type: string example: Plan expired or suspended NtfAuto_ErrorForbiddenScope: type: object required: - success - error - message properties: success: type: boolean enum: - false error: type: string enum: - Forbidden message: type: string responses: NtfAuto_EventSend200: description: >- Disparo aceito. `runs` pode ser vazio; `idempotentReplay` quando a mesma `Idempotency-Key` já foi processada. content: application/json: schema: $ref: '#/components/schemas/NtfAuto_EventSendResponse' examples: withRuns: value: success: true data: runs: - runId: clrunxxxxxxxxxxxxxxxxx automationId: clautyyyyyyyyyyyyyyyyy idempotent: value: success: true data: runs: - runId: clrunxxxxxxxxxxxxxxxxx automationId: clautyyyyyyyyyyyyyyyyy idempotentReplay: true noAutomations: value: success: true data: runs: [] NtfAuto_EventSend400: description: >- `event` ausente, prefixo reservado, `payload` inválido frente ao schema, ou destinatário inválido. content: application/json: schema: $ref: '#/components/schemas/NtfAuto_ErrorSend400' examples: missingEvent: value: success: false error: Bad Request message: event is required code: BAD_REQUEST reserved: value: success: false error: Event name uses reserved prefix code: RESERVED_EVENT message: Event name uses reserved prefix recipient: value: success: false error: Provide exactly one of contactId, email, or phone code: RECIPIENT_REQUIRED message: Provide exactly one of contactId, email, or phone payloadObject: value: success: false error: payload must be an object code: INVALID_PAYLOAD message: payload must be an object missingField: value: success: false error: 'Missing required field: plan' code: MISSING_PAYLOAD_FIELD message: 'Missing required field: plan' typeMismatch: value: success: false error: Field userId must be a string code: PAYLOAD_TYPE_MISMATCH message: Field userId must be a string NtfAuto_401: description: >- Chave ausente ou inválida. No middleware global de `/v1` também ocorre quando não há API Key. content: application/json: schema: $ref: '#/components/schemas/NtfAuto_ErrorEnvelope401' examples: route: value: success: false error: Unauthorized message: Invalid or missing API Key code: UNAUTHORIZED middleware: value: success: false error: Unauthorized message: >- API Key is required. Provide Authorization: Bearer or x-api-key header. code: UNAUTHORIZED NtfAuto_402: description: Plano expirado ou workspace suspenso. content: application/json: schema: $ref: '#/components/schemas/NtfAuto_ErrorPaymentRequired' example: success: false error: Payment Required message: Plan expired or suspended code: WORKSPACE_BLOCKED NtfAuto_403EventsWrite: description: Sem escopo `events:write`. content: application/json: schema: $ref: '#/components/schemas/NtfAuto_ErrorForbiddenScope' example: success: false error: Forbidden message: 'Missing scope: events:write' code: FORBIDDEN NtfAuto_EventSend404: description: Evento não cadastrado ou contato não encontrado. content: application/json: schema: $ref: '#/components/schemas/NtfAuto_ErrorSend400' examples: event: value: success: false error: Event is not registered for this workspace code: EVENT_NOT_DEFINED message: Event is not registered for this workspace contact: value: success: false error: Contact not found code: CONTACT_NOT_FOUND message: Contact not found securitySchemes: ntfAutoBearerAuth: type: http scheme: bearer bearerFormat: API Key description: '`Authorization: Bearer sk_live_...`' ntfAutoApiKeyHeader: type: apiKey in: header name: x-api-key description: Mesmo valor da chave, sem prefixo Bearer. ````