> ## Documentation Index > Fetch the complete documentation index at: https://docs.weve.cx/llms.txt > Use this file to discover all available pages before exploring further. # Ler um endpoint > O endpoint, com o estado e o disjuntor. O segredo não sai. ## OpenAPI ````yaml GET /v1/clubs/{clubId}/webhook-endpoints/{endpointId} openapi: 3.0.3 info: title: weve API description: > Contrato entre a API Go e o dashboard. **Este arquivo é a fonte de verdade**: os tipos e a interface de servidor em Go, e o client TypeScript, são todos gerados daqui (`make openapi`). Handler que divergir da interface não compila. A superfície interna (`/internal/*`) fica de fora de propósito: é acesso de máquina, protegido por segredo dedicado, e não é contrato de cliente. version: 0.2.0 servers: - url: https://api.weve.cx description: produção - url: http://localhost:8080 description: desenvolvimento security: [] tags: - name: health - name: session - name: account - name: clubs - name: members - name: webhooks - name: outgoing-webhooks - name: sales-platforms - name: catalog - name: content - name: classroom - name: community - name: mentorships - name: agents - name: lives - name: students - name: auth - name: campaigns - name: workflows - name: email paths: /v1/clubs/{clubId}/webhook-endpoints/{endpointId}: parameters: - $ref: '#/components/parameters/OrgId' - $ref: '#/components/parameters/WebhookEndpointId' get: tags: - outgoing-webhooks summary: Um endpoint description: | O mesmo da listagem, para um endpoint. Exige permissão de administração do club. operationId: getWebhookEndpoint responses: '200': description: O endpoint content: application/json: schema: $ref: '#/components/schemas/WebhookEndpointResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalError' security: - userSession: [] components: parameters: OrgId: name: clubId in: path required: true description: > Id público da organização — o mesmo que `GET /v1/me` devolve em `organization_id`. Na URL o recurso se chama **club**; no contrato e no domínio, organization. A divergência é deliberada: `clubs` é a palavra do produto, e a URL é o que as pessoas leem. É o identificador do provedor de autenticação, e é assim de propósito: o cliente precisa nomear a organização ao pedir o token, e o token é o que prova o escopo. Um id só nosso obrigaria a traduzir um no outro antes de ter um token — e a tradução exigiria uma chamada escopada, que é justamente a que ainda não dá para fazer. O uuid interno da organização não aparece no contrato: ele é o que as chaves estrangeiras do domínio referenciam, e continua sendo nosso. schema: type: string format: uuid WebhookEndpointId: name: endpointId in: path required: true schema: type: string format: uuid schemas: WebhookEndpointResponse: type: object required: - data properties: data: $ref: '#/components/schemas/WebhookEndpoint' WebhookEndpoint: type: object required: - id - url - description - event_types - status - disabled_reason - disabled_at - consecutive_failures - failing_since - hold_until - last_success_at - previous_secret_expires_at - pending_deliveries - created_at - updated_at properties: id: type: string format: uuid url: type: string description: type: string nullable: true event_types: type: array items: $ref: '#/components/schemas/WebhookEventType' status: $ref: '#/components/schemas/WebhookEndpointStatus' disabled_reason: allOf: - $ref: '#/components/schemas/WebhookEndpointDisabledReason' nullable: true disabled_at: type: string format: date-time nullable: true consecutive_failures: type: integer description: >- Tentativas seguidas sem resposta 2xx. A partir de 5, o endpoint recebe uma tentativa por vez. failing_since: type: string format: date-time nullable: true description: >- Desde quando nenhuma tentativa foi aceita. Cinco dias disso desligam o endpoint. hold_until: type: string format: date-time nullable: true description: Até quando o disjuntor segura as tentativas deste endpoint. last_success_at: type: string format: date-time nullable: true previous_secret_expires_at: type: string format: date-time nullable: true description: >- Enquanto no futuro, as entregas levam a assinatura do segredo anterior também. pending_deliveries: type: integer description: >- Entregas esperando na fila (inclui as retidas de um endpoint pausado). created_at: type: string format: date-time updated_at: type: string format: date-time ErrorEnvelope: type: object description: >- Envelope único de erro da API. O `code` é o contrato com o cliente — a `message` é diagnóstico, e pode mudar. required: - error properties: error: type: object required: - code properties: code: type: string message: type: string WebhookEventType: type: string description: > Os eventos em que um endpoint se inscreve. O nome é `recurso.acontecimento`, e cada um tem o corpo descrito em "Eventos de webhook". enum: - student.created - student.updated - student.removed - access.granted - access.revoked - access.extended - access.shortened - access.restored - access.moved - purchase.paid - purchase.refunded - subscription.past_due - subscription.canceled - lesson.completed - course.completed WebhookEndpointStatus: type: string enum: - enabled - paused - disabled description: | `enabled` entrega. `paused` retém: as entregas são criadas e esperam. `disabled` encerra: nada é criado e a fila é cancelada. WebhookEndpointDisabledReason: type: string enum: - manual - failing description: | `manual` é uma pessoa; `failing` é o disjuntor, depois de cinco dias sem nenhuma entrega aceita. responses: Unauthorized: description: Sessão ausente, expirada ou revogada content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Forbidden: description: > A sessão é válida, mas não age nesta organização. É a mesma resposta para uma organização que não existe — distinguir as duas deixaria enumerar organizações alheias. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' NotFound: description: Recurso não encontrado content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' InternalError: description: >- Falha inesperada. O corpo nunca traz o erro real — ele fica no log e no rastreamento. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: userSession: type: http scheme: bearer description: | Token OPACO de sessão de quem administra, emitido por `/v1/auth/admin/sign-in` e verificado contra a nossa tabela — o mesmo desenho do `studentSession`, para a outra identidade. É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o `studentSession`; uma rota consumida pelos dois declara os dois esquemas, e o middleware aceita qualquer um deles. As duas credenciais são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em que cada uma existe. O dashboard o guarda em cookie httpOnly, que o BFF troca pelo `Authorization` a cada chamada. ```` ## Related topics - [Ler um evento](/api-reference/webhooks/events-get.md) - [Ler um post](/api-reference/community/post-get.md) - [Ler playbook](/api-reference/mentorships/playbook-get.md) - [Ler aluno](/api-reference/students/get.md) - [Ler uma entrega](/api-reference/webhook-endpoints/deliveries-get.md)