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

# Listar webhooks de engajamento

> Lista os webhooks de engajamento cadastrados e as bandeiras sem webhook vinculado. Apenas bandeiras do mesmo grupo são consideradas, e somente bandeiras ativas são retornadas na lista de bandeiras sem webhook vinculado.



## OpenAPI

````yaml pages/v1/openapi-corridas.json GET /integracao/v1/engajamento/index
openapi: 3.1.0
info:
  title: API de Integração
  description: API de Integração v1
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api-vendas.taximachine.com.br/api/integracao
  - url: https://api.taximachine.com.br/api/integracao
security:
  - basicAuth: []
    ApiKeyAuth: []
paths:
  /integracao/v1/engajamento/index:
    servers:
      - url: https://api-vendas.taximachine.com.br
      - url: https://api.taximachine.com.br
    get:
      summary: Listar webhooks de engajamento
      description: >-
        Lista os webhooks de engajamento cadastrados e as bandeiras sem webhook
        vinculado. Apenas bandeiras do mesmo grupo são consideradas, e somente
        bandeiras ativas são retornadas na lista de bandeiras sem webhook
        vinculado.
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                type: object
              example:
                success: true
                data:
                  webhooks:
                    - id: 1
                      headers:
                        X-Cliente-Nome: nome-exemplo
                        X-Cliente-Chave: chave-exemplo
                      url: https://www.exemplo.url
                      bandeiras:
                        - id: 1
                          nome: Bandeira Exemplo 1
                          eventos:
                            - cadastro_passageiro_app
                            - estimativa_passageiro_app
                            - solicitacao_passageiro_app_abertura
                            - solicitacao_passageiro_app_finalizada
                        - id: 2
                          nome: Bandeira Exemplo 2
                          eventos:
                            - cadastro_passageiro_app
                            - estimativa_passageiro_app
                            - solicitacao_passageiro_app_abertura
                            - solicitacao_passageiro_app_finalizada
                        - id: 3
                          nome: Bandeira Exemplo 3
                          eventos:
                            - cadastro_passageiro_app
                            - estimativa_passageiro_app
                            - solicitacao_passageiro_app_abertura
                            - solicitacao_passageiro_app_finalizada
                    - id: 2
                      headers: null
                      url: https://www.exemplo.url2
                      bandeiras:
                        - id: 6
                          nome: Bandeira Exemplo 6
                          eventos:
                            - cadastro_passageiro_app
                            - estimativa_passageiro_app
                            - solicitacao_passageiro_app_abertura
                            - solicitacao_passageiro_app_finalizada
                  bandeiras_sem_webhook:
                    - id: 4
                      nome: Bandeira Exemplo 4
                    - id: 5
                      nome: Bandeira Exemplo 5
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api-key
      description: Obrigatório. Sua chave API.

````