Buttondown logo

Listing webhook attempts

Use the /webhooks/{id}/attempts endpoint to list all delivery attempts for a given webhook, including whether each attempt succeeded or failed.

Sample requests

These sample requests are autogenerated by the OpenAPI spec. This endpoint requires one or more parameters in the URL: those are offset in curly-braces.

import requests

url = "https://api.buttondown.com/v1/webhooks/{id}/attempts"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}

response = requests.request("GET", url, headers=headers)
print(response.text)

Sample responses

The IDs and values referenced in these responses are fake; please only rely on these responses for overall structure.

{
    "results": [
        {
            "id": "13121cd6-0dfc-424c-bb12-988b0a32fcb3",
            "creation_date": "2020-09-29T00:00:00Z",
            "status": "successful",
            "event_type": null,
            "error_message": null,
            "attempt_count": 0,
            "completion_date": null,
            "duration_ms": null
        }
    ],
    "count": 1
}

Path parameters

Consult the Filtering documentation for more information on how to filter and sort your requests.

status

Type
WebhookAttemptStatus
Description

If provided, only return webhook attempts with the given status.

page

Type
string
Description

The page number of the paginated response.