> ## Documentation Index
> Fetch the complete documentation index at: https://developer.omni.z-api.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get default webhook

> Retrieve the data of a specific default webhook

## Overview

Returns the data of a default webhook of the workspace. As in the list, authentication credentials and the `secret` are **not returned**.

An id from another workspace, of a channel webhook or of a template webhook gets `404`, the same response as an id that does not exist.

> [!NOTE]
>
> The `webhookId` comes from the [Create default webhook](/en/webhooks/create-default-webhook.md) or [List default webhooks](/en/webhooks/list-default-webhooks.md) response.


## OpenAPI

````yaml en/webhooks/openapi-default.json GET /v1/default-instance-webhooks/{webhookId}
openapi: 3.1.0
info:
  title: Omni Z-API - Workspace default webhook
  description: >-
    API to create and manage the workspace default webhook: a webhook without a
    channel that receives the events of every channel in the workspace that has
    no active webhook of its own. It accepts channel events, in the `DEFAULT`
    and `Z_API` formats, with up to 5 per workspace. It does not require the
    ENTERPRISE role: any valid secret key of an active workspace works.
  version: 1.0.0
servers:
  - url: https://api.omni.z-api.io
security:
  - bearerAuth: []
paths:
  /v1/default-instance-webhooks/{webhookId}:
    parameters:
      - name: webhookId
        in: path
        required: true
        description: Default webhook ID
        schema:
          type: string
          example: 5B7E3A90C2D14F6A8E1B2C3D4E5F6A7B
    get:
      tags:
        - Default webhook
      summary: Get default webhook
      description: >-
        Returns one default webhook of the workspace. Authentication credentials
        and the `secret` are not returned.
      operationId: getDefaultInstanceWebhook
      responses:
        '200':
          description: Default webhook found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultWebhookResponse'
              example:
                id: 5B7E3A90C2D14F6A8E1B2C3D4E5F6A7B
                channelId: null
                instanceId: null
                url: https://app.yourcompany.com/webhooks/omni-zapi
                description: Events from all channels
                events:
                  - MESSAGE_RECEIVED
                  - MESSAGE_STATUS
                  - DISCONNECTED
                status: ENABLED
                signing: false
                auth:
                  type: NONE
                  configured: false
                payloadFormat: DEFAULT
                customAttributes: {}
                createdAt: '2026-10-22T15:00:00.000+00:00'
                updatedAt: '2026-10-22T15:00:00.000+00:00'
        '400':
          description: Missing or invalid secret key, or IP outside the workspace list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                invalidKey:
                  summary: Missing or invalid secret key
                  value:
                    error: Authorization invalid
                ipNotAllowed:
                  summary: IP outside the workspace's allowed IP list
                  value:
                    error: 203.0.113.10 not allowed
        '404':
          description: >-
            There is no default webhook with this id in the workspace. An id
            from another workspace, from a channel webhook or from a template
            webhook gets the same response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Webhook not found
        '422':
          description: Deleted or nonexistent workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Webhook management requires an active workspace
components:
  schemas:
    DefaultWebhookResponse:
      type: object
      properties:
        id:
          type: string
          description: Default webhook ID
          example: 5B7E3A90C2D14F6A8E1B2C3D4E5F6A7B
        channelId:
          type:
            - string
            - 'null'
          description: 'Always `null`: the default webhook does not belong to a channel'
          example: null
        instanceId:
          type:
            - string
            - 'null'
          description: Always `null`. Legacy field, kept for compatibility
          deprecated: true
          example: null
        url:
          type: string
          example: https://app.yourcompany.com/webhooks/omni-zapi
        description:
          type:
            - string
            - 'null'
          example: Events from all channels
        events:
          type: array
          items:
            type: string
            enum:
              - MESSAGE_RECEIVED
              - MESSAGE_DELIVERY
              - MESSAGE_STATUS
              - RECEIVED_STATUS
              - RECEIVED_AND_DELIVERY
              - CONNECTED
              - DISCONNECTED
              - PRESENCE_CHAT
              - INITIAL_DATA
              - BLOCK
        status:
          type: string
          enum:
            - ENABLED
            - DISABLED
          description: '`ENABLED` or `DISABLED`'
        signing:
          type: boolean
          description: '`true` when HMAC signing is on'
        auth:
          $ref: '#/components/schemas/WebhookAuthInfo'
        payloadFormat:
          type: string
          enum:
            - DEFAULT
            - Z_API
        customAttributes:
          type: object
          additionalProperties: true
        createdAt:
          type: string
          format: date-time
          description: Creation date
        updatedAt:
          type: string
          format: date-time
          description: Last update date
    Error:
      type: object
      description: Error
      properties:
        error:
          type: string
          description: Error message
    WebhookAuthInfo:
      type: object
      description: Summary of the configured authentication. Credentials are not returned.
      properties:
        type:
          type: string
          enum:
            - NONE
            - BEARER
            - API_KEY
            - BASIC
            - CUSTOM_HEADER
          example: NONE
        configured:
          type: boolean
          description: '`true` when a credential is configured'
          example: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Secret Key generated in the Omni Z-API Security panel

````

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