sendmux-ai · Schema
WebhookSubscriptionWithSecretResponse
CompanyEmailArtificial IntelligenceAgentsIntegration
Properties
| Name | Type | Description |
|---|---|---|
| meta | object | |
| ok | boolean | |
| data | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/sendmux-ai/json-schema/sendmux-ai-webhook-subscription-with-secret-response-schema.json",
"title": "WebhookSubscriptionWithSecretResponse",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/sendmux-ai-webhooks-api-openapi.yml#/components/schemas/WebhookSubscriptionWithSecretResponse",
"allOf": [
{
"$ref": "#/$defs/SuccessEnvelope"
},
{
"properties": {
"data": {
"$ref": "#/$defs/WebhookSubscriptionWithSecret"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"data"
],
"type": "object"
}
],
"unevaluatedProperties": false,
"$defs": {
"ResponseMeta": {
"additionalProperties": false,
"properties": {
"request_id": {
"type": "string"
}
},
"required": [
"request_id"
],
"type": "object"
},
"SuccessEnvelope": {
"properties": {
"meta": {
"additionalProperties": {},
"properties": {},
"type": "object"
},
"ok": {
"enum": [
true
],
"type": "boolean"
}
},
"required": [
"ok",
"meta"
],
"type": "object"
},
"WebhookFilters": {
"additionalProperties": false,
"description": "Optional delivery scope. Empty mailbox_ids means all team mailboxes.",
"properties": {
"mailbox_ids": {
"description": "Mailbox public IDs to receive events for. Empty means all mailboxes in the team.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"mailbox_ids"
],
"type": "object"
},
"WebhookSubscriptionWithSecret": {
"additionalProperties": false,
"properties": {
"created_at": {
"description": "ISO 8601 creation timestamp",
"type": "string"
},
"enabled": {
"description": "When false, no events are delivered to this subscription.",
"type": "boolean"
},
"event_types": {
"description": "Event types this subscription receives.",
"items": {
"description": "Event types a webhook may subscribe to. `sendmux.test` is accepted so you can verify end-to-end delivery via POST /webhooks/{id}/test.",
"enum": [
"message.delivered",
"message.bounced",
"message.complained",
"message.rejected",
"message.delivery_delayed",
"message.received",
"message.received.spam",
"calendar.changed",
"sendmux.test"
],
"type": "string"
},
"type": "array"
},
"failing": {
"description": "True when the 24-hour retry window has been exhausted for this subscription. Reset by updating the subscription (e.g. fixing the URL) and re-enabling.",
"type": "boolean"
},
"filters": {
"$ref": "#/$defs/WebhookFilters"
},
"id": {
"description": "Webhook public ID",
"type": "string"
},
"name": {
"description": "Optional human-friendly label used in dashboard list/detail pages. May be `null` for subscriptions created without a name.",
"type": [
"string",
"null"
]
},
"secret": {
"description": "Signing secret for both webhook signature headers. X-Sendmux-Signature signs the exact body bytes. X-Sendmux-Signature-V2 contains v1=<hex HMAC-SHA256> and signs X-Sendmux-Timestamp (Unix seconds), a full stop, then the exact body bytes. Check timestamp freshness and compare signatures in constant time before parsing the body. Store this secret securely; it is returned only on creation and rotation. Use POST /webhooks/{id}/rotate-secret to issue a new one.",
"type": "string"
},
"updated_at": {
"description": "ISO 8601 last-modified timestamp",
"type": "string"
},
"url": {
"description": "HTTPS endpoint that receives signed event POSTs.",
"format": "uri",
"type": "string"
}
},
"required": [
"id",
"name",
"url",
"event_types",
"filters",
"enabled",
"failing",
"created_at",
"updated_at",
"secret"
],
"type": "object"
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/sendmux-ai-webhook-subscription-with-secret-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.