{ "opencollection": "1.0.0", "info": { "name": "Buttondown Webhooks API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Webhooks", "type": "folder" }, "items": [ { "info": { "name": "List Webhooks", "type": "http" }, "http": { "method": "GET", "url": "https://api.buttondown.com/v1/webhooks", "params": [ { "name": "status", "value": "", "type": "query", "description": "If provided, only return webhooks with the given status." }, { "name": "page", "value": "", "type": "query", "description": "The page number of the paginated response." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "List all webhooks" }, { "info": { "name": "Create Webhook", "type": "http" }, "http": { "method": "POST", "url": "https://api.buttondown.com/v1/webhooks", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new webhook" }, { "info": { "name": "Retrieve Webhook", "type": "http" }, "http": { "method": "GET", "url": "https://api.buttondown.com/v1/webhooks/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieve a specific webhook by its ID" }, { "info": { "name": "Update Webhook", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.buttondown.com/v1/webhooks/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update a webhook's properties" }, { "info": { "name": "Delete Webhook", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.buttondown.com/v1/webhooks/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete a webhook" }, { "info": { "name": "Retrieve Webhook Attempts", "type": "http" }, "http": { "method": "GET", "url": "https://api.buttondown.com/v1/webhooks/:id/attempts", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "status", "value": "", "type": "query", "description": "If provided, only return webhook attempts with the given status." }, { "name": "page", "value": "", "type": "query", "description": "The page number of the paginated response." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieve webhook attempts for a specific webhook" }, { "info": { "name": "Test Webhook", "type": "http" }, "http": { "method": "POST", "url": "https://api.buttondown.com/v1/webhooks/:id/test", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "event_type", "value": "", "type": "query", "description": "The event type to send. Defaults to the webhook's first configured event type." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send a test event to a webhook" } ] } ], "bundled": true }