Webhook Enviados
Recurso | Descrição |
---|---|
GET /api/v1/webhook_deliveries/:id | Informações do webhook enviado |
GET /api/v1/webhook_deliveries | Listar webhook enviados |
PUT /api/v1/webhook_deliveries/resend | Reenviar webhook |
Modelo de Dados
Parâmetro | Obrigatório | Tipo | Tamanho | Descrição |
---|---|---|---|---|
id | N/A | Integer | ID do webhook delivery | |
uid | N/A | String | 36 | UID usado no cabeçalho da requisição |
url | N/A | String | 255 | Endereço onde a entrega foi realizada, herdado do webhook |
request_payload | N/A | Hash | Payload que será enviado no corpo da mensagem. Ver possíveis valores em Payloads | |
request_error | N/A | String | 255 | Mensagem de erro retornada na resquisição |
response_headers | N/A | Hash | Cabeçalhos da resposta | |
response_body | N/A | Text | Conteúdo do corpo da resposta | |
response_code | N/A | Integer | Código HTTP da resposta. Leia mais | |
response_message | N/A | String | 255 | Mensagem relativa ao Código HTTP da resposta Leia mais |
delivered_at | N/A | DateTime | Data e hora que a entrega foi realizada | |
duration | N/A | Integer | Duração em milesegundos do round trip entre requisição e resposta | |
event_code | N/A | String | 255 | Código do evento. Ver possíveis valores na lista de eventos |
webhook_id | N/A | Integer | ID do Webhook | |
response_code | N/A | Integer | Código HTTP da resposta. Leia mais | |
uid | N/A | String | 255 | UID usado no cabeçalho da requisição |
status | N/A | Integer | Situação do webhook delivery (possíveis valores) | |
resource_owner_id | Não | Integer | ID do Objeto |
Dicionário de Dados
status
0 | pending |
1 | delivered |
2 | failed |
Informações do webhook enviado
GET /api/v1/webhook_deliveries/:id
Exemplo
curl -i \ -H "Authorization: Bearer $BOLETOSIMPLES_TOKEN" \ -H 'Content-Type: application/json' \ -H 'User-Agent: MyApp (myapp@example.com)' \ -X GET 'https://api-sandbox.kobana.com.br/v1/webhook_deliveries/1'Resposta:
HTTP/1.1 200 OK Date: Fri, 17 Oct 2014 19:46:16 GMT Status: 200 OK Content-Type: application/json; charset=utf-8 ... { "id": 1, "uid": "2397f7fb-cb15-4bfc-8296-0a973e93e551", "url": "https://example.com/callbacks/boletosimplest/", "duration": 119, "request_headers": { "X-BoletoSimples-Event": "bank_billet.generated", "X-Hub-Signature": "sha1=7be1e99e7ff2c2cd83222161e08593636e5bfe9a", "X-BoletoSimples-Delivery-Id": "2397f7fb-cb15-4bfc-8296-0a973e93e551", "X-BoletoSimples-Environment": "sandbox", "User-Agent": "BoletoSimples-Robot (sandbox)", "Content-Type": "application\/json" }, "request_payload": { "object": { "id":1, "expire_at":"2014-11-15", "paid_at":null, "description":"Prestação de Serviço", "status":"opened", "url":"http://bole.to/xxxxxxxx", "customer_person_type":"individual", "customer_person_name":"Nome do Cliente", "customer_cnpj_cpf":"125.812.717-28", "customer_address":"Rua quinhentos", "customer_state":"RJ", "customer_neighborhood":"bairro", "customer_zipcode":"12312-123", "customer_address_number":null, "customer_address_complement":null, "customer_phone_number":null, "customer_email":null, "send_email_on_creation":null, "created_via_api":true, "customer_city_name":null, "paid_amount":0.0, "amount":12.34 }, "event_code": "bank_billet.generated", "webhook": { "id": 5, "url": "https://example.com/callbacks/boletosimplest/" } }, "request_error": null, "response_body": "OK", "response_code": 200, "response_headers": { "access-control-allow-origin": [ "*" ], "content-type": [ "application\/json" ], "date": [ "Tue, 17 Mar 2015 01:56:05 GMT" ], "p3p": [ "CP=\"IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT\"" ], "server": [ "nginx" ], "strict-transport-security": [ "max-age=31536000; includeSubDomains; preload" ], "x-content-type-options": [ "nosniff" ], "x-frame-options": [ "SAMEORIGIN" ], "x-xss-protection": [ "1; mode=block" ], "content-length": [ "152" ], "connection": [ "Close" ] }, "response_message": "OK", "delivered_at": "2015-03-16T22:56:05.426-03:00" }
Listar webhook enviados
GET /api/v1/webhook_deliveries
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
page | Não | Number | Número da Página |
per_page | Não | Number | Quantidade de registros por página |
event_code | Não | String | Código do evento. Ver possíveis valores na lista de eventos |
webhook_id | Não | Number | ID do Webhook |
response_code | Não | Integer | Código HTTP da resposta. Leia mais |
uid | Não | String | UID usado no cabeçalho da requisição |
status | Não | Integer | Situação do webhook delivery (possíveis valores) |
resource_owner_id | Não | Integer | ID do Objeto |
O ID do Objeto
vai retornar todos e qualquer tipo de objeto que tenha o ID enviado, ou seja, se você enviar 1
, poderá retornar boletos, clientes e etc. Caso queira um filtro mais refinado, combine o ID do Objeto
com o Código do evento
.
Exemplo
curl -i \ -H "Authorization: Bearer $BOLETOSIMPLES_TOKEN" \ -H 'Content-Type: application/json' \ -H 'User-Agent: MyApp (myapp@example.com)' \ -X GET "https://api-sandbox.kobana.com.br/v1/webhook_deliveries?page=1&per_page=2"Resposta:
HTTP/1.1 200 OK Date: Fri, 17 Oct 2014 19:46:16 GMT Status: 200 OK Link: <https://api-sandbox.kobana.com.br/v1/webhook_deliveries?page=2&per_page=2>; rel="last", <https://api-sandbox.kobana.com.br/v1/webhook_deliveries?page=2&per_page=2>; rel="next" Total: 4 Content-Type: application/json; charset=utf-8 ... [ { "id": 197, "uid": "2397f7fb-cb15-4bfc-8296-0a973e93e551", "url": "https://example.com/callbacks/boletosimplest/", "duration": 119, "request_headers": { "X-BoletoSimples-Event": "bank_billet.generated", "X-Hub-Signature": "sha1=7be1e99e7ff2c2cd83222161e08593636e5bfe9a", "X-BoletoSimples-Delivery-Id": "2397f7fb-cb15-4bfc-8296-0a973e93e551", "X-BoletoSimples-Environment": "sandbox", "User-Agent": "BoletoSimples-Robot (sandbox)", "Content-Type": "application\/json" }, "request_payload": { "object": { "id":1, "expire_at":"2014-11-15", "paid_at":null, "description":"Prestação de Serviço", "status":"opened", "url":"http://bole.to/xxxxxxxx", "customer_person_type":"individual", "customer_person_name":"Nome do Cliente", "customer_cnpj_cpf":"125.812.717-28", "customer_address":"Rua quinhentos", "customer_state":"RJ", "customer_neighborhood":"bairro", "customer_zipcode":"12312-123", "customer_address_number":null, "customer_address_complement":null, "customer_phone_number":null, "customer_email":null, "send_email_on_creation":null, "created_via_api":true, "customer_city_name":null, "paid_amount":0.0, "amount":12.34 }, "event_code": "bank_billet.generated", "webhook": { "id": 5, "url": "https://example.com/callbacks/boletosimplest/" } }, "request_error": null, "response_body": "OK", "response_code": 200, "response_headers": { "access-control-allow-origin": [ "*" ], "content-type": [ "application\/json" ], "date": [ "Tue, 17 Mar 2015 01:56:05 GMT" ], "p3p": [ "CP=\"IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT\"" ], "server": [ "nginx" ], "strict-transport-security": [ "max-age=31536000; includeSubDomains; preload" ], "x-content-type-options": [ "nosniff" ], "x-frame-options": [ "SAMEORIGIN" ], "x-xss-protection": [ "1; mode=block" ], "content-length": [ "152" ], "connection": [ "Close" ] }, "response_message": "OK", "delivered_at": "2015-03-16T22:56:05.426-03:00" } ]
Reenviar webhook
PUT /api/v1/webhook_deliveries/resend
ou PATCH /api/v1/webhook_deliveries/resend
Está limitado aos primeiros 1000 encontrados na busca conforme os parâmetros.
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
event_code | Não | String | Código do evento. Ver possíveis valores na lista de eventos |
webhook_id | Não | Integer | ID do Webhook |
response_code | Não | Integer | Código HTTP da resposta. Leia mais |
uid | Não | String | UID usado no cabeçalho da requisição |
status | Não | Integer | Situação do webhook delivery (possíveis valores) |
resource_owner_id | Não | Integer | ID do Objeto |
created_from | Não | Date | A partir da Data de criação (DD/MM/YYYY) ou (YYYY-MM-DD) |
created_to | Não | Date | Até a Data de criação (DD/MM/YYYY) ou (YYYY-MM-DD) |
O ID do Objeto
vai retornar todos e qualquer tipo de objeto que tenha o ID enviado, ou seja, se você enviar 1
, poderá retornar boletos, clientes e etc. Caso queira um filtro mais refinado, combine o ID do Objeto
com o Código do evento
.
Exemplo
curl -i \ -H "Authorization: Bearer $BOLETOSIMPLES_TOKEN" \ -H 'Content-Type: application/json' \ -H 'User-Agent: MyApp (myapp@example.com)' \ -d '{"event_code":"bank_billet.paid","status":2}' \ -X PUT "https://api-sandbox.kobana.com.br/v1/webhook_deliveries/resend"Resposta:
HTTP/1.1 200 OK Date: Fri, 17 Oct 2014 19:46:16 GMT Content-Type: application/json; charset=utf-8 Status: 200 OK ... {"message":"Solicitação de reenvio de webhook deliveries enviada para processamento"}