Skip to content

setTrackingWebhook.md

Latest commit

 

History

History
28 lines (18 loc) · 1.28 KB

setTrackingWebhook.md

File metadata and controls

28 lines (18 loc) · 1.28 KB
Raw

setTrackingWebhook

Set or replace the domain's dedicated tracking-event webhook: an HTTPS endpoint that receives signed email.* engagement events (email.sent / email.bounced / email.complained / email.opened / email.clicked, shaped per the tracking-event schema) SEPARATELY from inbound mail. This is the split-endpoint override for consumers that keep engagement events away from their inbound webhook (e.g. django-anymail's paired views); most consumers should prefer setWebhookEvents, which delivers everything to the one inbound webhook. When both are configured, this URL wins for engagement events. Returns the signing secret (the same account secret as inbound deliveries).

HTTP: PUT /api/domains/{id}/tracking-webhook

Parameters

Field Type Required Description
url string ✓ HTTPS endpoint to receive signed email.* engagement events…

Returns

set-tracking-webhook-response — see the set-tracking-webhook-response schema.

Example

res = mk.setTrackingWebhook({
    "id": "dom_1",
    "url": "https://app.com/hooks/mailkite-events",
})

← All methods · Docs · mailkite.dev