Skip to content

Webhook

The webhook API has two mutually exclusive modes:

  1. Inbound Email Webhook echoValue assigns an opaque mailbox address in the form <mailboxId>@hook.echovalue.dev. Every received email is forwarded to your webhook URL.
  2. Scheduled Webhook echoValue calls your webhook URL on a recurring schedule defined by a 5-field cron expression and an IANA timezone.

Each webhook is managed through a public webhookId. If you omit it when creating a webhook, echoValue uses default.

NeedModeWhat you sendWhat you get backPayload
Turn inbound email into HTTP callsInbound Email Webhookurl plus optional format, template, options, includeAttachmentsAn opaque email addressInbound email payload or transformed format payload
Run recurring HTTP callbacksScheduled Webhookurl plus scheduleSchedule metadata such as nextRunAtScheduled-run payload
Verify delivery manuallyTest WebhookExisting webhookIdDelivery result with successTest payload
Send to Slack, Discord, Teams, Telegram, or PagerDutyInbound Email Webhook with formatPlatform-specific format and optionsAn opaque email addressPlatform-native payload
PageEndpoint
Create WebhookPOST /webhook
List WebhooksGET /webhook
Get WebhookGET /webhook/<webhookId>
Update WebhookPUT /webhook/<webhookId> and PATCH /webhook/<webhookId>
Delete WebhookDELETE /webhook/<webhookId>
Test WebhookPOST /webhook/<webhookId>/test
Webhook PayloadsDelivery payload schemas
GuideWhen to use it
Webhook Inbound EmailYou want an email address that forwards inbound email to Slack, Discord, PagerDuty, or your own endpoint
Webhook Scheduled JobsYou want cron-style webhook execution without any mailbox address

Format adapters apply only to the inbound email mode.

FormatPlatform
slackSlack Incoming Webhooks
discordDiscord Webhooks
teamsMicrosoft Teams
telegramTelegram Bot API
pagerdutyPagerDuty Events API v2
customCustom JSON template

Without a format, the raw inbound email payload is forwarded as-is. Scheduled webhooks always deliver the scheduled-run JSON payload.

OperationCost
Configure webhook1 credit
Get webhook config1 credit
Delete webhook1 credit
Test webhook1 credit
Scheduled cron run2 credits
Email processed (no attachments)2 credits
Email processed (with attachments)5 credits