> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bevits.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Consultar evento

> Devolve um evento pelo ID: o cliente a que foi ligado e o que aconteceu com cada flow que o escuta (queued, started ou skipped com o motivo). Disponível logo depois do envio e durante os 13 meses de histórico.



## OpenAPI

````yaml /openapi.json get /v1/events/{event_id}
openapi: 3.1.0
info:
  title: Bevits API
  version: 1.0.0
  description: >-
    API pública para consultar dados de CRM, compras e automação de uma
    organização Bevits, criar automações como rascunho para revisão e ativação,
    criar campanhas de WhatsApp Oficial como rascunho e montar segmentos e tags
    de clientes.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.bevits.com
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Sistema
    description: Disponibilidade da API.
  - name: Identidade
    description: Identidade da organização e da API key.
  - name: Clientes
    description: Clientes e suas relações.
  - name: Segmentos
    description: Segmentos de clientes.
  - name: Compras
    description: Compras importadas das integrações.
  - name: Dados do CRM
    description: Tags e definições de atributos.
  - name: Automações
    description: Flows de automação.
  - name: Campanhas
    description: Campanhas de e-mail.
  - name: Conta e marca
    description: Contexto da conta, identidade da marca e imagens.
  - name: Receitas
    description: Automações prontas criadas a partir de receitas, com desfazer.
  - name: Templates de e-mail
    description: Criação e importação de templates de e-mail.
  - name: Eventos
    description: Eventos personalizados enviados pela loja e seus tipos.
paths:
  /v1/events/{event_id}:
    get:
      tags:
        - Eventos
      summary: Consultar evento
      description: >-
        Devolve um evento pelo ID: o cliente a que foi ligado e o que aconteceu
        com cada flow que o escuta (queued, started ou skipped com o motivo).
        Disponível logo depois do envio e durante os 13 meses de histórico.
      operationId: getEvent
      parameters:
        - $ref: '#/components/parameters/EventId'
      responses:
        '200':
          $ref: '#/components/responses/Event'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/ReadScopeRequired'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    EventId:
      name: event_id
      in: path
      required: true
      description: ID público do evento.
      schema:
        type: string
        pattern: ^evt_[A-Za-z0-9_-]+$
  responses:
    Event:
      description: Evento encontrado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Event'
          example:
            object: event
            id: evt_01jd2v9k3m8q4r5s6t7u8v9w0x
            name: order_shipped
            external_id: ship_10293
            occurred_at: '2026-11-18T17:03:00.000Z'
            received_at: '2026-11-18T17:03:01.000Z'
            customer:
              id: cus_ckabc123
              matched_by: external_id
              created: false
            flows:
              - id: flw_ckdef456
                name: Pedido enviado
                status: started
              - id: flw_ckghi789
                name: Entrega expressa
                status: skipped
                reason: filter_not_matched
            properties:
              order_number: '10293'
              tracking:
                code: BR123
                carrier: Correios
              items:
                - sku: CAM-01
                  name: Camiseta
                  quantity: 2
            backfill: false
            livemode: true
    InvalidRequest:
      description: Parâmetro de rota inválido.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: API key ausente, inválida, expirada ou revogada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: authentication_error
              message: Invalid API key.
              request_id: req_07f6cdc3c20249d6afcd90b4
    ReadScopeRequired:
      description: >-
        A API key não tem o escopo read. É o caso de uma chave só de envio,
        criada apenas com events:write.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: permission_denied
              code: missing_scope
              message: This API key does not have the required "read" scope.
              param: scope
              request_id: req_07f6cdc3c20249d6afcd90b4
    NotFound:
      description: Recurso inexistente ou pertencente a outra organização.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    RateLimited:
      description: Limite de requisições excedido.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitErrorResponse'
    InternalError:
      description: Erro inesperado no servidor.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    Event:
      type: object
      required:
        - object
        - id
        - name
        - occurred_at
        - received_at
        - customer
        - flows
        - backfill
        - livemode
      properties:
        object:
          type: string
          const: event
        id:
          type: string
          pattern: ^evt_[A-Za-z0-9_-]+$
        name:
          type: string
        external_id:
          type: string
        occurred_at:
          type: string
          format: date-time
        received_at:
          type: string
          format: date-time
        customer:
          type: object
          description: >-
            Cliente a que o evento foi ligado. Uma chave só de envio
            (events:write) recebe apenas id.
          properties:
            id:
              type: string
              pattern: ^cus_[A-Za-z0-9_-]+$
              description: >-
                Ausente quando o evento criaria o cliente e ele não foi criado:
                na validação e no modo de teste.
            matched_by:
              type: string
              enum:
                - id
                - external_id
                - tax_id
                - email
                - phone
              description: >-
                Identificador que encontrou o cliente. Ausente quando o evento
                criou o cliente.
            created:
              type: boolean
              description: true quando o evento criou o cliente.
            would_create:
              type: boolean
              const: true
              description: >-
                Presente na validação e no modo de teste, quando o envio criaria
                o cliente.
        flows:
          type: array
          description: >-
            Flows ativos que escutam esse nome de evento. Lista vazia significa
            que nenhum flow está escutando.
          items:
            $ref: '#/components/schemas/EventFlow'
        properties:
          type: object
          additionalProperties: true
          description: Propriedades como foram enviadas. Ausente depois de 30 dias.
        backfill:
          type: boolean
        livemode:
          type: boolean
        warnings:
          type: array
          description: >-
            Presente apenas quando há algo a avisar. Um aviso nunca substitui um
            erro.
          items:
            $ref: '#/components/schemas/EventWarning'
        duplicate:
          type: boolean
          const: true
          description: >-
            Presente quando a chamada devolveu um evento que já existia com o
            mesmo name e external_id.
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/Error'
    RateLimitErrorResponse:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          required:
            - retry_after
          properties:
            retry_after:
              type: integer
              minimum: 1
              description: Segundos até uma nova tentativa.
    EventFlow:
      type: object
      required:
        - id
        - name
        - status
      properties:
        id:
          type: string
          pattern: ^flw_[A-Za-z0-9_-]+$
        name:
          type: string
        status:
          type: string
          enum:
            - queued
            - started
            - skipped
          description: >-
            queued é decidido na resposta do envio. Ao consultar o evento
            depois, o flow aparece como started ou skipped.
        reason:
          type: string
          enum:
            - backfill
            - stale
            - filter_not_matched
            - test_mode
            - no_contact_channel
            - no_consent
            - flow_inactive
            - flow_error
            - dispatch_failed
          description: Por que o flow foi pulado. Presente quando status é skipped.
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/EventFlowWarning'
          description: >-
            O que um flow iniciado não conseguiu fazer e quem envia pode
            corrigir, como uma mensagem pulada por uma variável sem valor.
            Presente só quando há algo a avisar.
    EventWarning:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          enum:
            - ambiguous_identifier
            - identifier_conflict
            - identifier_mismatch
            - payload_mismatch
        message:
          type: string
        param:
          type: string
    Error:
      type: object
      required:
        - type
        - message
        - request_id
      properties:
        type:
          type: string
          enum:
            - authentication_error
            - conflict
            - internal_error
            - invalid_request
            - not_found
            - permission_denied
            - rate_limited
            - validation_error
        code:
          type: string
          description: >-
            Motivo estável e legível por máquina dentro de type, como
            invalid_event_name. Presente quando o erro tem um motivo nomeado.
        message:
          type: string
        param:
          type: string
          description: >-
            Caminho completo do campo com problema, como customer.email ou
            events[3].name.
        suggestion:
          type: string
          description: Um valor que seria aceito, quando existe um óbvio.
        request_id:
          type: string
          pattern: ^req_[a-f0-9]{24}$
    EventFlowWarning:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          enum:
            - missing_variable
          description: >-
            missing_variable: uma mensagem do flow foi pulada porque uma
            variável do template não tinha valor nem texto alternativo.
        message:
          type: string
        param:
          type: string
          description: >-
            A propriedade do evento que faltou, como properties.tracking.code.
            Ausente quando a variável não é do evento.
  headers:
    RetryAfter:
      description: Segundos até uma nova tentativa.
      schema:
        type: integer
        minimum: 1
    RateLimitLimit:
      description: Limite total da janela atual.
      schema:
        type: integer
        example: 600
    RateLimitRemaining:
      description: Requisições restantes na janela atual.
      schema:
        type: integer
        example: 599
    RateLimitReset:
      description: Instante UTC em que a janela atual termina.
      schema:
        type: string
        format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: bvt_live_...
      description: API key criada nas configurações da organização.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.