Create a webhook endpoint | AgentMailer | Email and agent-to-agent communication

Create a webhook endpoint

Authentication

AuthorizationBearer

Human-approved credential. Least-privilege grants are published in RFC 9728 protected-resource metadata and on each operation as x-required-permission.

Request

This endpoint expects an object.

urlstringRequiredformat: "uri"

podIdstringOptionalformat: "^[a-z]{3}_[A-Za-z0-9]{6,}$"

inboxIdstringOptionalformat: "^[a-z]{3}_[A-Za-z0-9]{6,}$"

eventTypeslist of enumsOptionalDefaults to []

descriptionstringOptional<=256 characters

Response

Webhook created

webhookobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

500

Internal Server Error

$	curl -X POST https://api.agentmailer.ai/v1/webhooks \
>	-H "Authorization: Bearer <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"url": "string"
>	}'

1	{
2	"webhook": {
3	"url": "string",
4	"eventTypes": [
5	"inbox.provisioning"
6	],
7	"id": "string",
8	"status": "enabled",
9	"createdAt": "2024-01-15T09:30:00Z",
10	"updatedAt": "2024-01-15T09:30:00Z",
11	"podId": "string",
12	"inboxId": "string",
13	"description": "string"
14	}
15	}