Endpoints de webhook
Criar um endpoint de webhook
Registra uma URL para receber tipos exatos de eventos da organização ou de organizações conectadas e retorna o secret Standard Webhooks.
Cria um
webhook_endpoint. A resposta traz o secret usado para verificar as assinaturas das entregas; ele também volta em toda consulta do endpoint.
Obrigatórios: url e events. Todo o resto tem default.
Este endpoint aceita Idempotency-Key.
Autenticação
Use a API key da organização com escopowrite; com ela, o header Organization não é aceito.
Com Chargefy for Platforms, a API key de plataforma também cria
endpoints: envie no header
Organization a organização em que atua, como em
qualquer recurso da conta. Para ouvir as organizações conectadas
(events_from: "platform"), o header é a própria organização da plataforma
— o campo organization de
GET /v1/platforms/{id}. Numa organização
conectada, a chave cria só endpoints events_from: "organization", com os
eventos daquela organização.Attributes
Tipos de evento que o endpoint deve receber. Pelo menos um, todos do catálogo público. Tipo desconhecido ou evento
organization.* usado com events_from: "organization" retorna 400; duplicados são removidos. Os valores são exatos: wildcards como payment.intent.*, charge.* e * não são aceitos.Fluxo de eventos que o endpoint ouve. Imutável após a criação — para trocar de fluxo, crie outro endpoint.
URL que recebe as entregas via
POST. Precisa ser https e apontar para um endereço público, em produção e em teste. Redirecionamentos não são seguidos: cadastre a URL final.O que a Chargefy resolve sozinha
secret— gerado no formatowhsec_<base64 de 32 bytes aleatórios>. Não é aceito no payload.- Ambiente — o endpoint nasce no ambiente da API key usada (
livemode). Ele só recebe eventos desse ambiente. events_from— nasceorganizationquando omitido.
Para receber eventos próprios e eventos das organizações conectadas, crie dois endpoints: um com
events_from: "organization" e outro com events_from: "platform". A URL pode ser a mesma, mas cada endpoint tem um secret independente.Resposta
200 OK com o objeto webhook_endpoint completo, incluindo o secret.
Erros
Catálogo de eventos
Valores exatos aceitos em
events e payload individual de cada tipo.Integração com Payment Intents
Inscrição recomendada para os cinco eventos de Payment Intent.

