> ## 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.

# Criar webhook de engajamento

> Cria um webhook de engajamento a partir da URL. Os headers são opcionais e limitados a 10 chaves. Não é possível criar dois webhooks com a mesma URL.



## OpenAPI

````yaml pages/v1/openapi-corridas.json POST /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
    post:
      summary: Criar webhook de engajamento
      description: >-
        Cria um webhook de engajamento a partir da URL. Os headers são opcionais
        e limitados a 10 chaves. Não é possível criar dois webhooks com a mesma
        URL.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - url
              properties:
                url:
                  type: string
                  description: Obrigatório. URL para envio dos eventos.
                headers:
                  type: object
                  description: >-
                    Opcional. Headers utilizados no envio à URL. Limite de 10
                    chaves.
                  additionalProperties:
                    type: string
            example:
              url: https://mariela.net
      responses:
        '201':
          description: Criado com sucesso
          content:
            application/json:
              schema:
                type: object
              example:
                success: true
                message: Webhook de engajamento criado com sucesso.
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api-key
      description: Obrigatório. Sua chave API.

````