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

# Add a webhook

> Adds an https link we post events to (at most 5). The signing secret is in this answer only.

Permission: A Full key.



## OpenAPI

````yaml /openapi.json post /v1/webhooks
openapi: 3.1.0
info:
  title: GetReply API
  version: 1.0.0
  description: >-
    Send WhatsApp messages, templates, OTPs and campaigns from your own
    software. Every request needs an API key (Developer → API keys) as a Bearer
    token.


    Requests sent here are real and charged like any other.
servers:
  - url: https://api.getreply.in
    description: GetReply
security:
  - bearerAuth: []
tags:
  - name: Account
  - name: Messages
  - name: Templates
  - name: Contacts
  - name: Campaigns
  - name: Webhooks
paths:
  /v1/webhooks:
    post:
      tags:
        - Webhooks
      summary: Add a webhook
      description: >-
        Adds an https link we post events to (at most 5). The signing secret is
        in this answer only.


        Permission: A Full key.
      parameters:
        - name: Idempotency-Key
          in: header
          required: true
          description: >-
            Your own unique id for this request (at most 255 characters). The
            same id and body within 24 hours answers the first answer again —
            never a second send or charge.
          schema:
            type: string
            maxLength: 255
          example: webhook-events-1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - url
                - events
              properties:
                url:
                  type: string
                  description: An https link.
                events:
                  type: array
                  items:
                    type: string
                    enum:
                      - message.sent
                      - message.delivered
                      - message.read
                      - message.failed
                      - message.received
                      - wallet.low
                      - number.quality_changed
                      - number.status_changed
                      - number.name_changed
                      - template.status_changed
                      - template.quality_changed
                      - template.created
                      - template.deleted
                      - campaign.started
                      - campaign.finished
                      - campaign.paused
                      - campaign.stopped
            example:
              url: https://example.com/whatsapp-events
              events:
                - message.delivered
                - message.received
      responses:
        '201':
          description: Added; copy the secret now.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Webhook'
                  - type: object
                    properties:
                      secret:
                        type: string
        '400':
          description: >-
            webhook_url_invalid: The webhook link must start with https://. ·
            validation_error: Some fields are missing or wrong.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                webhook_url_invalid:
                  value:
                    error:
                      code: webhook_url_invalid
                      message: The webhook link must start with https://.
                validation_error:
                  value:
                    error:
                      code: validation_error
                      message: Some fields are missing or wrong.
        '401':
          description: 'unauthorized: API key is missing or not valid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                unauthorized:
                  value:
                    error:
                      code: unauthorized
                      message: API key is missing or not valid.
        '403':
          description: >-
            key_off: This API key is switched off. · forbidden_scope: This API
            key isn't allowed to do this. · ip_not_allowed: Requests from this
            IP address aren't allowed for this key. · needs_pro_plan: The API
            needs the Pro plan. · plan_ended: Your plan has ended. Renew it to
            send messages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                key_off:
                  value:
                    error:
                      code: key_off
                      message: This API key is switched off.
                forbidden_scope:
                  value:
                    error:
                      code: forbidden_scope
                      message: This API key isn't allowed to do this.
                ip_not_allowed:
                  value:
                    error:
                      code: ip_not_allowed
                      message: >-
                        Requests from this IP address aren't allowed for this
                        key.
                needs_pro_plan:
                  value:
                    error:
                      code: needs_pro_plan
                      message: The API needs the Pro plan.
                plan_ended:
                  value:
                    error:
                      code: plan_ended
                      message: Your plan has ended. Renew it to send messages.
        '409':
          description: >-
            request_id_reused: This request ID was already used for a different
            request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                request_id_reused:
                  value:
                    error:
                      code: request_id_reused
                      message: >-
                        This request ID was already used for a different
                        request.
        '429':
          description: 'rate_limited: Too many requests. Try again in a few seconds.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                rate_limited:
                  value:
                    error:
                      code: rate_limited
                      message: Too many requests. Try again in a few seconds.
        '500':
          description: 'server_error: Something went wrong on our side. Try again.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                server_error:
                  value:
                    error:
                      code: server_error
                      message: Something went wrong on our side. Try again.
components:
  schemas:
    Webhook:
      type: object
      properties:
        id:
          type: string
        url:
          type: string
        events:
          type: array
          items:
            type: string
        status:
          type: string
          enum:
            - 'ON'
            - 'OFF'
        created_at:
          type:
            - string
            - 'null'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            field:
              type: string
              description: The one field that is wrong, when there is one.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. gr_live_…

````

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