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

# Enregistrer un webhook sortant

> Ce que fait un connecteur quand un scénario est activé. La réponse porte le `secret`, **une seule fois** : chaque appel de Lekalao est signé avec lui (`X-Lekalao-Signature`, HMAC-SHA256 du corps brut). L'adresse doit être publique : une adresse qui pointe à l'intérieur d'un réseau est refusée ici, pas au premier appel.



## OpenAPI

````yaml /api-reference/openapi.fr.json post /v1/webhooks
openapi: 3.1.0
info:
  title: API Lekalao
  version: 1.0.0
  description: >-
    Tout ce que fait l'interface, votre application peut le faire aussi. Chaque
    appel porte un jeton d'API (Paramètres → Jetons d'API).
servers:
  - url: https://api.lekalao.com
    description: Lekalao
  - url: https://{host}/api
    description: Votre propre installation
    variables:
      host:
        default: lekalao.example.com
        description: Le domaine de votre installation
security:
  - bearer: []
tags:
  - name: Listes
  - name: Abonnés
  - name: Tags
  - name: Segments
  - name: Imports
  - name: Modèles
  - name: Campagnes
  - name: Automatisations
  - name: E-mails transactionnels
  - name: Revenu
  - name: Champs de contact
  - name: Événements
  - name: Webhooks
  - name: Plateforme
paths:
  /v1/webhooks:
    post:
      tags:
        - Webhooks
      summary: Enregistrer un webhook sortant
      description: >-
        Ce que fait un connecteur quand un scénario est activé. La réponse porte
        le `secret`, **une seule fois** : chaque appel de Lekalao est signé avec
        lui (`X-Lekalao-Signature`, HMAC-SHA256 du corps brut). L'adresse doit
        être publique : une adresse qui pointe à l'intérieur d'un réseau est
        refusée ici, pas au premier appel.
      operationId: api.webhooks.store
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - url
                - events
              properties:
                url:
                  type: string
                  format: uri
                  maxLength: 2000
                events:
                  type: array
                  minItems: 1
                  items:
                    type: string
                    enum:
                      - subscriber.created
                      - subscriber.confirmed
                      - subscriber.unsubscribed
                      - subscriber.tag_added
                      - subscriber.tag_removed
                      - campaign.sent
                      - mail.bounced
                      - mail.complaint
                list_id:
                  type:
                    - string
                    - 'null'
                  format: uuid
                  description: Seulement ce qui se passe dans cette liste.
                name:
                  type:
                    - string
                    - 'null'
                  description: Son nom dans les paramètres. L'hôte de l'adresse, si absent.
            example:
              url: https://hooks.example.com/lekalao
              events:
                - subscriber.created
                - subscriber.unsubscribed
      responses:
        '201':
          description: Webhook enregistré. `secret` n'est montré qu'ici.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    allOf:
                      - $ref: '#/components/schemas/Webhook'
                      - type: object
                        properties:
                          secret:
                            type: string
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      schema:
        type: string
        maxLength: 255
      description: >-
        Rejouez une écriture sans risque : la même clé rend la première réponse
        pendant 24 heures (en-tête Idempotent-Replay: true).
  schemas:
    Webhook:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        url:
          type: string
          format: uri
        events:
          type: array
          items:
            type: string
            enum:
              - subscriber.created
              - subscriber.confirmed
              - subscriber.unsubscribed
              - subscriber.tag_added
              - subscriber.tag_removed
              - campaign.sent
              - mail.bounced
              - mail.complaint
        list_id:
          type:
            - string
            - 'null'
          format: uuid
        active:
          type: boolean
          description: Coupé par Lekalao après des échecs répétés.
    Message:
      type: object
      properties:
        message:
          type: string
    ValidationError:
      type: object
      properties:
        message:
          type: string
          example: Le champ email doit être une adresse e-mail valide.
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
  responses:
    Unauthenticated:
      description: Aucun jeton, ou un jeton invalide ou révoqué.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Message'
          example:
            message: Unauthenticated.
    Forbidden:
      description: Le jeton n'a pas l'aptitude requise, ou l'équipe est suspendue.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Message'
    ValidationFailed:
      description: Données invalides.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationError'
    TooManyRequests:
      description: >-
        Limite du jeton atteinte. Attendez le nombre de secondes indiqué par
        Retry-After.
      headers:
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Appels permis par minute pour ce jeton.
        X-RateLimit-Remaining:
          schema:
            type: integer
        Retry-After:
          schema:
            type: integer
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: >-
        Jeton d'API. Aptitude « read » : routes GET seulement. « read + write »
        : toutes les routes.

````