List webhook events
GET {{baseUrl}}/{{version}}/event
Get a list of non-deleted events in chunks of at most 100. If you need smaller chunks, use the limit parameter.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
cursor | null | String used to get the next batch of results. | |
limit | null | Number of results per cursor. Max = 100. | |
fields | null | List of strings to filter response JSON keys. | |
after | null | Filter entities created after this date. | |
before | null | Filter entities created before this date. | |
isDelivered | null | If false, only gets events that haven't been delivered. If true, only gets events that have already been delivered. |
RESPONSES
status: OK
{"cursor":null,"events":[{"log":{"id":"4633062025461760","errors":[],"type":"registered","boleto":{"taxId":"20.018.183/0001-80","overdueLimit":59,"fine":2,"id":"6642467306733568","receiverName":"Winterfell S. A.","city":"São Paulo","fee":0,"streetLine2":"CJ 13","district":"Itaim Bibi","streetLine1":"Av. Faria Lima, 1844","due":"2020-10-01T02:59:59.999999+00:00","discounts":[{"date":"2020-09-26T02:59:59.999999+00:00","percentage":10},{"date":"2020-09-27T02:59:59.999999+00:00","percentage":9}],"workspaceId":"4888651368497152","interest":1.3,"status":"registered","tags":["war supply","invoice #1234"],"zipCode":"01500-000","line":"34191.09107 11410.957309 71444.640008 7 83940028000000","name":"Iron Bank S.A.","created":"2020-09-01T19:35:35.708298+00:00","receiverTaxId":"71.735.814/0001-12","barCode":"34197839400280000001091011410957307144464000","amount":28000000,"stateCode":"SP","descriptions":[{"text":"McDonnell Douglas F-15 Eagle","amount":27000000},{"text":"US Drone","amount":1000000}]},"created":"2020-09-01T19:35:36.284215+00:00"},"subscription":"boleto","isDelivered":false,"id":"4783825322246144","created":"2020-09-01T19:35:37.349018+00:00"}]}