{ "opencollection": "1.0.0", "info": { "name": "BTCPay Greenfield API Keys Webhooks API", "version": "v1" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Webhooks", "type": "folder" }, "items": [ { "info": { "name": "Get webhooks of a store", "type": "http" }, "http": { "method": "GET", "url": "https://{btcpay-host}/api/v1/stores/:storeId/webhooks", "params": [ { "name": "storeId", "value": "", "type": "path", "description": "The store ID" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "View webhooks of a store" }, { "info": { "name": "Create a new webhook", "type": "http" }, "http": { "method": "POST", "url": "https://{btcpay-host}/api/v1/stores/:storeId/webhooks", "params": [ { "name": "storeId", "value": "", "type": "path", "description": "The store ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new webhook" }, { "info": { "name": "Get a webhook", "type": "http" }, "http": { "method": "GET", "url": "https://{btcpay-host}/api/v1/webhooks/:webhookId", "params": [ { "name": "webhookId", "value": "", "type": "path", "description": "The webhook id" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "View webhook" }, { "info": { "name": "Update a webhook", "type": "http" }, "http": { "method": "PUT", "url": "https://{btcpay-host}/api/v1/webhooks/:webhookId", "params": [ { "name": "webhookId", "value": "", "type": "path", "description": "The webhook id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update a webhook" }, { "info": { "name": "Delete a webhook", "type": "http" }, "http": { "method": "DELETE", "url": "https://{btcpay-host}/api/v1/webhooks/:webhookId", "params": [ { "name": "webhookId", "value": "", "type": "path", "description": "The webhook id" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete a webhook" }, { "info": { "name": "Get latest deliveries", "type": "http" }, "http": { "method": "GET", "url": "https://{btcpay-host}/api/v1/webhooks/:webhookId/deliveries", "params": [ { "name": "webhookId", "value": "", "type": "path", "description": "The webhook id" }, { "name": "count", "value": "", "type": "query", "description": "The number of latest deliveries to fetch" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "List the latest deliveries to the webhook, ordered from the most recent" }, { "info": { "name": "Get a webhook delivery", "type": "http" }, "http": { "method": "GET", "url": "https://{btcpay-host}/api/v1/webhooks/:webhookId/deliveries/:deliveryId", "params": [ { "name": "webhookId", "value": "", "type": "path", "description": "The webhook id" }, { "name": "deliveryId", "value": "", "type": "path", "description": "The id of the delivery" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Information about a webhook delivery" }, { "info": { "name": "Get the delivery's request", "type": "http" }, "http": { "method": "GET", "url": "https://{btcpay-host}/api/v1/webhooks/:webhookId/deliveries/:deliveryId/request", "params": [ { "name": "webhookId", "value": "", "type": "path", "description": "The webhook id" }, { "name": "deliveryId", "value": "", "type": "path", "description": "The id of the delivery" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "The delivery's JSON request sent to the endpoint" }, { "info": { "name": "Redeliver the delivery", "type": "http" }, "http": { "method": "POST", "url": "https://{btcpay-host}/api/v1/webhooks/:webhookId/deliveries/:deliveryId/redeliver", "params": [ { "name": "webhookId", "value": "", "type": "path", "description": "The webhook id" }, { "name": "deliveryId", "value": "", "type": "path", "description": "The id of the delivery" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Redeliver the delivery" } ] } ], "bundled": true }