This page only applies to Enterprise customers with Spotzee’s high-deliverability email service enabled. It does not apply to non-Enterprise customers or projects using standard provider delivery.
Webhook endpoint management lives under Settings → Webhook Endpoints at
/projects/{projectId}/settings/webhooks and requires the project admin role.Add an endpoint
1
Open Settings → Webhook Endpoints
Inside the project, open Settings and select Webhook Endpoints.
2
Create the endpoint
Choose Add endpoint, then complete:
- Name. Recognisable label (for example,
analytics-pipeline). - Description. Optional. Useful for documenting what the endpoint is for.
- URL. Where Spotzee will POST events. Must be HTTPS.
- Events. Pick the event names you want to receive. See the catalogue below.
3
Save
Save. Spotzee generates a signing secret and shows it once. Copy the secret into your endpoint’s secrets manager. Subsequent reads return the secret in masked form.
Choose events
Choose the events that match the signals your downstream system needs. Each forwarded payload includes the event type, project identifier, timestamp, and event-specific data.
You can subscribe to as many events as you like. Keep the list focused if your receiver routes different event types to different systems.
For the wire-level format, signing scheme, and API endpoint management, see Webhook conventions.
Payload details
Live delivery webhooks use the same top-level wrapper as other Spotzee webhooks. Thedata object changes by event type and includes the delivery details available for that event.
Spotzee omits unavailable values and may add extra diagnostic keys over time. Build receivers to ignore fields they do not use.
Common detail fields by event family:
Event catalogue
Theevent_type value in the webhook payload matches the names below exactly.
Queue events
Delivery lifecycle events
Delivery success event
Bounce and rejection events
Routing and connection events
Encrypted delivery events
Reputation events
Test the endpoint
The test action sends a sample payload to your endpoint. Use it to validate reachability and signature verification before relying on live event traffic.1
Open the endpoint
In Settings → Webhook Endpoints, open the row for the endpoint.
2
Run a test
Use the Send test action. Spotzee posts a sample payload signed with the test-path scheme:
X-Spotzee-Signature: sha256=<hex> where the hex is the HMAC-SHA256 of the request body using your endpoint’s signing secret.3
Verify the signature
Your endpoint should compute the same HMAC over the request body and compare it to the header value. A match confirms the request came from Spotzee. Reject any request whose signature doesn’t match.
Spotzee-Signature: t=...,v1=... signing envelope. Test deliveries use X-Spotzee-Signature: sha256=<hex> so you can verify the endpoint from the Spotzee UI.
Rotate the signing secret
Rotate when a secret might have been exposed (committed to source, shared in a chat, leaked in a log).1
Open the endpoint
In Settings → Webhook Endpoints, open the row for the endpoint.
2
Rotate the secret
Use the Rotate secret action. Spotzee generates a new signing secret and shows it once. Copy it into your secrets manager.
3
Update your verifier
Update your endpoint to use the new secret. Only the new secret is valid after rotation; the old secret stops verifying immediately.
Endpoint status
Endpoints carry one of three statuses:
Inactive and disabled endpoints don’t dispatch events but their configuration is preserved. Re-enable to resume.
Next steps
Webhook conventions
The wire-level signing scheme and event payload shape.
Trigger a campaign
Send a campaign and watch enabled delivery events flow into your endpoint.
Manage API keys
Issue project keys for downstream integrations.
Concepts
Brush up on Users, Journeys, Segments, Channels, and Providers.