{ "opencollection": "1.0.0", "info": { "name": "API Reference agent webhooks API", "version": "1.0.0" }, "items": [ { "info": { "name": "webhooks", "type": "folder" }, "items": [ { "info": { "name": "List Webhooks", "type": "http" }, "http": { "method": "GET", "url": "https://api.agentmail.to/v0/webhooks", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "page_token", "value": "", "type": "query" }, { "name": "ascending", "value": "", "type": "query" } ] }, "docs": "**CLI:**\n```bash\nagentmail webhooks list\n```" }, { "info": { "name": "Create Webhook", "type": "http" }, "http": { "method": "POST", "url": "https://api.agentmail.to/v0/webhooks", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**CLI:**\n```bash\nagentmail webhooks create --url https://example.com/webhook --event-type message.received\n```" }, { "info": { "name": "Get Webhook", "type": "http" }, "http": { "method": "GET", "url": "https://api.agentmail.to/v0/webhooks/:webhook_id", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "webhook_id", "value": "", "type": "path" } ] }, "docs": "**CLI:**\n```bash\nagentmail webhooks get --webhook-id \n```" }, { "info": { "name": "Update Webhook", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.agentmail.to/v0/webhooks/:webhook_id", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "webhook_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update inbox or pod subscriptions, or replace the webhook's `event_types` in full when you pass a\nnon-empty `event_types` array (see request field docs). Inbox and pod changes use add/remove lists.\n\n**CLI:**\n```bash\nagentmail webhooks update --webhook-id --add-inbox-id \n```" }, { "info": { "name": "Delete Webhook", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.agentmail.to/v0/webhooks/:webhook_id", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "webhook_id", "value": "", "type": "path" } ] }, "docs": "**CLI:**\n```bash\nagentmail webhooks delete --webhook-id \n```" } ] } ], "bundled": true }