{ "opencollection": "1.0.0", "info": { "name": "API Reference agent inboxes > webhooks API", "version": "1.0.0" }, "items": [ { "info": { "name": "inboxes > webhooks", "type": "folder" }, "items": [ { "info": { "name": "List Webhooks", "type": "http" }, "http": { "method": "GET", "url": "https://api.agentmail.to/v0/inboxes/:inbox_id/webhooks", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "inbox_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "page_token", "value": "", "type": "query" }, { "name": "ascending", "value": "", "type": "query" } ] }, "docs": "**CLI:**\n```bash\nagentmail inboxes:webhooks list --inbox-id \n```" }, { "info": { "name": "Create Webhook", "type": "http" }, "http": { "method": "POST", "url": "https://api.agentmail.to/v0/inboxes/:inbox_id/webhooks", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "inbox_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a webhook scoped to this inbox.\n\n**CLI:**\n```bash\nagentmail inboxes:webhooks create --inbox-id --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/inboxes/:inbox_id/webhooks/:webhook_id", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "inbox_id", "value": "", "type": "path" }, { "name": "webhook_id", "value": "", "type": "path" } ] }, "docs": "**CLI:**\n```bash\nagentmail inboxes:webhooks get --inbox-id --webhook-id \n```" }, { "info": { "name": "Update Webhook", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.agentmail.to/v0/inboxes/:inbox_id/webhooks/:webhook_id", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "inbox_id", "value": "", "type": "path" }, { "name": "webhook_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**CLI:**\n```bash\nagentmail inboxes:webhooks update --inbox-id --webhook-id --event-type message.received\n```" }, { "info": { "name": "Delete Webhook", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.agentmail.to/v0/inboxes/:inbox_id/webhooks/:webhook_id", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "inbox_id", "value": "", "type": "path" }, { "name": "webhook_id", "value": "", "type": "path" } ] }, "docs": "**CLI:**\n```bash\nagentmail inboxes:webhooks delete --inbox-id --webhook-id \n```" } ] } ], "bundled": true }