API Reference
Start typing to search…

Generate Undelivered Webhooks Report

post https://developer-api.bringg.com/services/d51c9a96//

This API retrieves a list of webhooks which Bringg sent without receiving a confirmation during a specified time period. Bringg tries to send each webhook three times. After a third failed attempt, if the expected response confirmation from the recipient system does not arrive, the webhook is attached to this report.

This endpoint can also be accessed using the OAuth 2.0 URL ending in /services/get_undelivered_webhooks and including the report_read scope.


As a response to this API request, Bringg sends the webhooks report to the email or callback_url included in the request. The report is sent as a link to a CSV file, which begins to download after you log in with your Bringg account details.

You can also automatically access the report by sending an authentication key and the report UUID.

  1. Copy the UUID after the reportId from the callback_url response to this API. For example, if the response is https://dashboard.bringg.com?reportId=be5fefa1-9b7e-406c-8449-d167a6672d22, the reportId is be5fefa1-9b7e-406c-8449-d167a6672d22
  2. Retrieve your login authentication_token by sending this request: 
    curl -H "Content-Type: application/json"  
 -XPOST <https://admin-api.bringg.com/tokens>  
 -d'{ "email":"<USER_EMAIL>", "password": "<PASSWORD>" }'
  3. Obtain the link to the report (CSV file) by using the reportId from the callback_url as detailed in step 1 and the authentication_token from step 2: 
     curl -v -H "Authorization: Token token=<authentication token>" <https://admin-api.bringg.com/reports-service/v1/report_execution?uuid=<reportId>

The response is a JSON containing a URL to a short-lived (30 days) CSV file.

📘

Note

Only one copy of the failed webhook will be sent, even if there were multiple attempts to send it.

Webhook Types

To specify which webhooks to include in the report, include a value from this list in the webhook_type array. You can also leave the array null to receive all failed webhooks from the time span you specify in your request.

Language