> ## 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. # Enviar teste > Uma entrega webhook.test pelo mesmo caminho dos eventos de verdade. ## OpenAPI ````yaml POST /v1/clubs/{clubId}/webhook-endpoints/{endpointId}/test 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}/test: parameters: - $ref: '#/components/parameters/OrgId' - $ref: '#/components/parameters/WebhookEndpointId' post: tags: - outgoing-webhooks summary: Manda um evento de teste description: > Cria uma entrega `webhook.test` para este endpoint e a põe na frente da fila. Ela passa pelo MESMO caminho de qualquer evento (assinatura, conferência do endereço, novas tentativas), então o teste que passa prova o que vai acontecer com os eventos de verdade. A resposta sai antes do POST: acompanhe o resultado lendo a entrega devolvida. O disjuntor não segura o teste — é o jeito de conferir, na hora, que o outro lado voltou. Exige permissão de administração do club. Erros: `endpoint_not_enabled` (409, pausado ou desligado); `not_configured` (501). operationId: testWebhookEndpoint responses: '202': description: Na fila. É a entrega a acompanhar. content: application/json: schema: $ref: '#/components/schemas/WebhookDeliveryResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' '501': $ref: '#/components/responses/NotConfigured' 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: WebhookDeliveryResponse: type: object required: - data properties: data: $ref: '#/components/schemas/WebhookDelivery' WebhookDelivery: type: object required: - id - endpoint_id - message_id - event_type - occurred_at - status - attempts - in_flight - next_attempt_at - last_attempt_at - last_status_code - last_error - cancel_reason - completed_at - created_at properties: id: type: string format: uuid endpoint_id: type: string format: uuid message_id: type: string format: uuid description: >- O `webhook-id` — o id do evento, igual em toda tentativa e em todo endpoint. event_type: $ref: '#/components/schemas/WebhookMessageType' occurred_at: type: string format: date-time status: $ref: '#/components/schemas/WebhookDeliveryStatus' attempts: type: integer in_flight: type: boolean description: Uma tentativa está acontecendo agora. next_attempt_at: type: string format: date-time nullable: true description: Só enquanto `pending`. last_attempt_at: type: string format: date-time nullable: true last_status_code: type: integer nullable: true last_error: type: string nullable: true cancel_reason: allOf: - $ref: '#/components/schemas/WebhookCancelReason' nullable: true completed_at: type: string format: date-time nullable: true created_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 WebhookMessageType: type: string description: >- O tipo de uma mensagem entregue — os eventos, mais o `webhook.test` do botão de teste. 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 - webhook.test WebhookDeliveryStatus: type: string enum: - pending - succeeded - failed - canceled description: > `pending` espera a próxima tentativa (ou está em voo, com `in_flight`). `succeeded` recebeu 2xx. `failed` esgotou as tentativas. `canceled` não vai sair: o endpoint foi desligado, o aluno de quem o corpo fala foi removido, ou a entrega passou 30 dias pendente (`cancel_reason`). WebhookCancelReason: type: string enum: - endpoint_disabled - student_removed - expired description: > `endpoint_disabled`: o endpoint foi desligado. `student_removed`: o aluno de quem o corpo fala foi removido. `expired`: ficou pendente mais de 30 dias (um endpoint pausado), e o corpo precisava sair no prazo. 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' Conflict: description: >- Conflito com o estado atual. O `code` diz qual; a descrição da operação lista os possíveis. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' TooManyRequests: description: Teto por IP atingido headers: Retry-After: schema: type: integer 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' NotConfigured: description: | O ambiente não tem o que a operação precisa (`not_configured`): o provedor de autenticação nas rotas de sessão, o e-mail nas que enviam link, a chave de cifra nos webhooks. 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 - [Enviar teste](/api-reference/campaigns/test.md) - [Enviar teste do passo](/api-reference/workflows/email-test.md) - [Webhooks de saída](/essentials/webhooks.md) - [webhook.test](/api-reference/webhook-events/test.md) - [Enviar imagem de comentário](/api-reference/comments/image-create.md)