O recurso webhook
Webhook (callbacks) é uma forma de se registrar para receber informações úteis de uma URL específica de sua escolha. Você pode criar múltiplos webhooks!
Quando um evento desencadeia um webhook (por exemplo, uma transação foi aprovada com sucesso), tentaremos enviar essa notificação para a URL que foi especificada.
Caso seu sistema responda com um status code 200 será entendido que o evento foi recebido e não será enviado novamente, no entanto, pode acontecer de eventos serem disparados mais de uma vez, aconselhamos que realize um tratamento adequado em sua aplicação.
Atributos
| Id | string Identificador exclusivo para este webhook |
|---|---|
| resource | string Value: webhook |
| url | string A URL ( pública ) para a qual os dados do evento serão postados. A carga útil dos dados Webhook é enviada como JSON no corpo de solicitação POST. |
| description | string A URL ( pública ) para a qual os dados do evento serão postados. A carga útil dos dados Webhook é enviada como JSON no corpo de solicitação POST. |
| status | enum (registered, active, deleted) Indica o status atual deste webhook registered: Webhook criado active: Webhook ativo e pronto para receber deleted: Webhook deletado O webhook só se torna active após uma verificação feita pela WC Pagamentos, através de um ping, que é disparado afim de identificar se a URL é pública e válida. Exemplo de ping: { "id": "7dbefcb2a9614565ac92d5411669844d", "type": "ping", "resource": "event", "payload": { "object": { "ping": "true" } }, "source": null, "name": null, "uri": "/v1/marketplaces/8efzad2e595343fbbe9f9725d9hc9711/events/7dbefcb2a9614565ac92d5411669844d", "created_at": "2020-04-01T18:21:33+0000", "updated_at": "2020-04-01T18:21:33+0000" } |
| event | array Esta é uma lista dos tipos de eventos que seu webhook estará monitorando. Você pode monitorar um ou mais eventos. Na sessão de eventos você terá uma lista detalhada sobre todos os objetos. |
| last_error | string Se já tivemos um erro ao tentar publicar neste webhook, o último erro que vimos. |
| retries | integer Número de tentativas anteriores para entregar este evento webhook. |
| batches_sent | integer O número de lotes de eventos que já foram enviados para este webhook. |
| metadata | opcional {"key": "value"} ou null Mapeamento de chaves de string para valores de sequência de caracteres. key é o identificador para as metadatas (máximo de 30 caracteres). O value é a informação a ser armazenada como metadatas. |
| created_at | string W3C Datetime Format para a criação da data (yyyy-mm-ddThh:mm:ssZ) |
| updated_at | string W3C Datetime Format para a última atualização (yyyy-mm-ddThh:mm:ssZ) |