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

KeyDatatypeRequiredDescription
cursornullString used to get the next batch of results.
limitnullNumber of results per cursor. Max = 100.
afternullFilter entities created after this date.
beforenullFilter entities created before this date.
isDeliverednullIf false, only gets events that haven't been delivered. If true, only gets events that have already been delivered.
fieldsnullList of strings to filter response JSON keys.

RESPONSES

status: OK

{"cursor":"Ck0KFAoHY3JlYXRlZBIJCIag87iNkuwCEjFqFGl-YXBpLW1zLXdlYmhvb2stc2J4chkLEgxOb3RpZmljYXRpb24YgICAsLGF9gkMGAAgAQ==","events":[{"created":"2020-10-01T00:20:01.193589+00:00","id":"6055708030140416","isDelivered":false,"log":{"created":"2020-10-01T00:20:00.972515+00:00","holmes":{"boletoId":"5423289434374144","created":"2020-10-01T00:10:07.279259+00:00","id":"5227200064258048","result":"registered","status":"solved","tags":["boleto/5423289434374144","trigger/20"],"updated":"2020-10-01T00:20:00.972538+00:00"},"id":"5097993824894976","type":"solved","updated":"2020-10-01T00:20:00.972543+00:00"},"subscription":"boleto-holmes","workspaceId":"6341320293482496"},{"created":"2020-10-01T00:10:18.514103+00:00","id":"6496535470669824","isDelivered":false,"log":{"boleto":{"amount":289,"barCode":"34199840000000002891091015608157307144464000","city":"São Paulo","created":"2020-09-30T23:49:53.248484+00:00","descriptions":[{"amount":123,"text":"product A"},{"amount":456,"text":"product B"},{"amount":789,"text":"product C"}],"discounts":[{"date":"2020-10-01T02:59:59.999999+00:00","percentage":5.0},{"date":"2020-10-02T02:59:59.999999+00:00","percentage":3.0}],"district":"Jardim Paulista","due":"2020-10-07T02:59:59.999999+00:00","fee":200,"fine":2.0,"id":"6634200702648320","interest":1.0,"line":"34191.09107 15608.157309 71444.640008 9 84000000000289","name":"William Mayfield","ourNumber":"10156081","overdueLimit":10,"receiverName":"Stark Bank S.A.","receiverTaxId":"20.018.183/0001-80","stateCode":"SP","status":"paid","streetLine1":"Rua ABC","streetLine2":"Ap 123","tags":[],"taxId":"172.279.942-01","workspaceId":"6341320293482496","zipCode":"01234-567"},"created":"2020-10-01T00:10:15.848203+00:00","errors":[],"id":"6456892440182784","type":"credited"},"subscription":"boleto","workspaceId":"6341320293482496"},{"created":"2020-10-01T00:10:16.459425+00:00","id":"5402977338654720","isDelivered":false,"log":{"boleto":{"amount":254,"barCode":"34191839500000002541091015607167307144464000","city":"São Paulo","created":"2020-09-30T23:49:36.658945+00:00","descriptions":[{"amount":123,"text":"product A"},{"amount":456,"text":"product B"},{"amount":789,"text":"product C"}],"discounts":[{"date":"2020-10-01T02:59:59.999999+00:00","percentage":5.0},{"date":"2020-10-02T02:59:59.999999+00:00","percentage":3.0}],"district":"Jardim Paulista","due":"2020-10-02T02:59:59.999999+00:00","fee":200,"fine":2.0,"id":"6371486130503680","interest":1.0,"line":"34191.09107 15607.167309 71444.640008 1 83950000000254","name":"Holly Morris","ourNumber":"10156071","overdueLimit":10,"receiverName":"Issac Jory","receiverTaxId":"119.628.402-47","stateCode":"SP","status":"paid","streetLine1":"Rua ABC","streetLine2":"Ap 123","tags":[],"taxId":"48.676.425/0001-41","workspaceId":"6341320293482496","zipCode":"01234-567"},"created":"2020-10-01T00:10:13.646959+00:00","errors":[],"id":"6115671649812480","type":"credited"},"subscription":"boleto","workspaceId":"6341320293482496"},{"created":"2020-10-01T00:10:15.313200+00:00","id":"4641614341341184","isDelivered":false,"log":{"boleto":{"amount":253,"barCode":"34196840100000002531091015608077307144464000","city":"São Paulo","created":"2020-09-30T23:49:53.248347+00:00","descriptions":[{"amount":123,"text":"product A"},{"amount":456,"text":"product B"},{"amount":789,"text":"product C"}],"discounts":[{"date":"2020-10-01T02:59:59.999999+00:00","percentage":5.0},{"date":"2020-10-02T02:59:59.999999+00:00","percentage":3.0}],"district":"Jardim Paulista","due":"2020-10-08T02:59:59.999999+00:00","fee":200,"fine":2.0,"id":"6282356981760000","interest":1.0,"line":"34191.09107 15608.077309 71444.640008 6 84010000000253","name":"Mathew Hussey","ourNumber":"10156080","overdueLimit":10,"receiverName":"Stark Bank S.A.","receiverTaxId":"20.018.183/0001-80","stateCode":"SP","status":"paid","streetLine1":"Rua ABC","streetLine2":"Ap 123","tags":[],"taxId":"508.442.036-10","workspaceId":"6341320293482496","zipCode":"01234-567"},"created":"2020-10-01T00:10:12.747607+00:00","errors":[],"id":"4660025897254912","type":"credited"},"subscription":"boleto","workspaceId":"6341320293482496"},{"created":"2020-10-01T00:10:14.322182+00:00","id":"5585704121794560","isDelivered":false,"log":{"boleto":{"amount":270,"barCode":"34194839500000002701091015607327307144464000","city":"São Paulo","created":"2020-09-30T23:49:43.749912+00:00","descriptions":[{"amount":123,"text":"product A"},{"amount":456,"text":"product B"},{"amount":789,"text":"product C"}],"discounts":[{"date":"2020-10-01T02:59:59.999999+00:00","percentage":5.0},{"date":"2020-10-02T02:59:59.999999+00:00","percentage":3.0}],"district":"Jardim Paulista","due":"2020-10-02T02:59:59.999999+00:00","fee":200,"fine":2.0,"id":"6267714364506112","interest":1.0,"line":"34191.09107 15607.327309 71444.640008 4 83950000000270","name":"Kourtney Ortiz","ourNumber":"10156073","overdueLimit":10,"receiverName":"Stark Bank S.A.","receiverTaxId":"20.018.183/0001-80","stateCode":"SP","status":"paid","streetLine1":"Rua ABC","streetLine2":"Ap 123","tags":[],"taxId":"634.597.915-51","workspaceId":"6341320293482496","zipCode":"01234-567"},"created":"2020-10-01T00:10:11.673416+00:00","errors":[],"id":"6051648518488064","type":"credited"},"subscription":"boleto","workspaceId":"6341320293482496"}]}