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

# Detalhar endpoint de webhook

> Busca um endpoint de webhook da empresa pelo ID. O segredo de assinatura não é retornado.

**Escopo necessário:** `webhook-endpoint:read`



## OpenAPI

````yaml api-reference/v3/openapi.json GET /api/v3/webhook-endpoints/{id}
openapi: 3.1.0
info:
  version: v3
  title: Salvy API
  x-logo:
    url: web/logo.png
servers:
  - url: https://api.salvy.com.br
    description: Salvy API URL
security:
  - bearerAuth: []
tags:
  - name: Public API
  - name: Outgoing Webhooks
paths:
  /api/v3/webhook-endpoints/{id}:
    get:
      tags:
        - Public API
      description: >-
        Busca um endpoint de webhook da empresa pelo ID. O segredo de assinatura
        não é retornado.


        **Escopo necessário:** `webhook-endpoint:read`
      operationId: publicGetWebhookEndpointV3
      parameters:
        - name: id
          in: path
          required: true
          schema:
            $schema: https://json-schema.org/draft/2020-12/schema
            type: string
            minLength: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  id:
                    type: string
                    description: ID do endpoint de webhook.
                    example: ep_2yZwUhtgs5Ai8T9yRQJXA
                  url:
                    type: string
                    format: uri
                    description: URL HTTPS que recebe os eventos.
                    example: https://exemplo.com.br/webhooks/salvy
                  eventTypes:
                    type: array
                    items:
                      type: string
                    description: >-
                      Tipos de evento enviados a este endpoint. Um endpoint sem
                      filtro de eventos recebe todos os tipos e lista todos os
                      disponíveis em GET /webhook-event-types.
                    example:
                      - phone-account.activated
                      - phone-account.canceled
                  description:
                    description: Descrição do endpoint; null quando não informada.
                    example: Integração com o ERP
                    type:
                      - string
                      - 'null'
                  disabled:
                    type: boolean
                    description: >-
                      Indica se o endpoint está desativado. Um endpoint
                      desativado não recebe eventos.
                    example: false
                  createdAt:
                    type: string
                    format: date-time
                    pattern: >-
                      ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                    description: Data e hora de criação do endpoint (ISO 8601, UTC).
                    example: '2026-10-13T14:30:00.000Z'
                required:
                  - id
                  - url
                  - eventTypes
                  - description
                  - disabled
                  - createdAt
                additionalProperties: false
        '401':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - unauthorized
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '403':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - forbidden
                      - insufficient-scope
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - resource-not-found
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '413':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - payload-too-large
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '422':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - input-validation-error
                      - unprocessable-entity
                      - company-not-active
                  message:
                    type: string
                  details:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                        message:
                          type: string
                      required:
                        - key
                        - message
                      additionalProperties: false
                required:
                  - code
                  - message
                additionalProperties: {}
        '429':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - too-many-attempts
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - unknown
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
      deprecated: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: key

````

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