O que são?

Os Webhooks são as notificações que enviamos para você sempre que um evento ocorre.

A cada atualização, o sistema envia um HTTP POST para a URL configurada no webhook, com todas as informações relevantes sobre cobranças, pedidos, assinaturas, entre outros. Desta maneira, o seu sistema, ao receber essa notificação, pode executar os próximos passos.

Você tem total liberdade para escolher sobre quais eventos quer ser notificado e para qual URL cada webhook será enviado.

1303

📘

Contornando falhas no recebimento dos webhooks

Pensando na possibilidade do seu serviço, por qualquer motivo, não conseguir receber o webhook, criamos uma configuração pela qual você pode definir quantas vezes iremos reenviá-lo em caso de falha no recebimento.

De qualquer forma, nossa API também tem um endpoint pelo qual você pode consultar quais webhooks falharam, e forçar os seus envios manualmente.

Eventos disponíveis

Temos uma lista de eventos importantes que podem ocorrer na nossa API. Veja abaixo!

EventoDescrição
customer.createdOcorre sempre que um comprador é criado
customer.updatedOcorre sempre que um comprador é atualizado
card.createdOcorre sempre que um cartão é criado
card.updatedOcorre sempre que um cartão é atualizado
card.deletedOcorre sempre que um cartão é deletado
address.createdOcorre sempre que um endereço é criado
address.updatedOcorre sempre que um endereço é atualizado
address.deletedOcorre sempre que um endereço é deletado
plan.createdOcorre sempre que um plano é criado
plan.updatedOcorre sempre que um plano é atualizado
plan.deletedOcorre sempre que um plano é deletado
planitem.createdOcorre sempre que um item de plano é criado
planitem.updatedOcorre sempre que um item de plano é atualizado
planitem.deletedOcorre sempre que um item de plano é deletado
subscription.createdOcorre sempre que uma assinatura é criada
subscription.updatedOcorre sempre que uma assinatura é atualizada
subscription.canceledOcorre sempre que uma assinatura é cancelada
subscriptionitem.createdOcorre sempre que um item de assinatura é criado
subscriptionitem.updatedOcorre sempre que um item de assinatura é atualizado
subscriptionitem.deletedOcorre sempre que um item de assinatura é deletado
discount.createdOcorre sempre que um desconto é criado
discount.deletedOcorre sempre que um desconto é deletado
order.paidOcorre sempre que um pedido é pago
order.payment_failedOcorre sempre que o pagamento de um pedido falha
order.createOcorre sempre que um pedido é criado
order.canceledOcorre sempre que um pedido é cancelado
invoice.createdOcorre sempre que uma fatura é criada
invoice.paidOcorre sempre que uma fatura é paga
invoice.payment_failedOcorre sempre que o pagamento de uma fatura falha
invoice.canceledOcorre sempre que uma fatura é cancelada
charge.paidOcorre sempre que uma cobrança é paga
charge.payment_failedOcorre sempre que o pagamento de uma cobrança falha
charge.pendingOcorre sempre que o pagamento de uma cobrança estiver pendente
charge.refundedOcorre sempre que uma cobrança é estornada
checkout.createdOcorre sempre que um pedido do tipo de checkout é criado
checkout.closedOcorre sempre que um pedido de checkout encontra-se em processamento ou quando foi pago
checkout.canceledOcorre sempre que um pedido de checkout teve seu link de pagamento expirado
recipient.createdOcorre sempre que um recebedor é criado
recipient.updatedOcorre sempre que um recebedor é atualizado

Saiba mais sobre os Webhooks através de nossa API Reference!