Choose the event that answers your question
recipient_exported- A recipient export completes and its result URLs arrive.
recipient_failed- A recipient render fails.
all_exported- The order reaches its all-recipients-exported milestone.
These events describe export progress. They do not establish message delivery, a video play or a conversion. Choose the event based on the action your receiving system should take.
Shape the handoff
The workspace export webhook configuration supports event selection and payload mapping. Organization defaults can be overridden for an individual order. Select the event and recipient fields that the receiving workflow needs, then verify a sample notification against its expected input.
For example, a receiving application could record the exported video URL against its own campaign record. That is an integration design example: the downstream action is implemented by the receiving system.
Verify the complete notification path
Test the configured event, receiver and field mapping together. Check how your receiver handles repeated notifications, missing optional fields and a result it cannot yet process. Confirm the actual authentication, retry and event behavior of the deployment before relying on delivery guarantees.
This guide covers workspace export webhooks. Customer webhook subscription management is outside the documented Engage API V1 contract.
QUESTIONS, WITH CONTEXT
Go one question deeper.
Explore the details that matter for this part of the workflow.
Events and meaning
A notification should say exactly what happened.
Which export events can the workspace webhook configuration select?
The documented configuration supports recipient_exported, recipient_failed and all_exported. They describe recipient or order export milestones, not message delivery or viewer engagement.
Does recipient_exported mean the video was watched?
No. It describes a completed export with result URLs. Message delivery, playback and a viewer’s next action require evidence from the relevant delivery or player workflow.
Can an order use different webhook settings from the organization default?
The export webhook configuration supports organization defaults and individual order overrides. Confirm the effective settings for the order being tested, including the selected events and payload mapping.
Receiver integration
Make the payload and the receiving action agree.
What is webhook payload mapping for?
It selects and maps the event and recipient fields into the format expected by the receiving workflow. Verify a sample with the receiver and include only the fields needed for its next action.
Are webhook retry and signing guarantees established here?
No. Confirm the actual authentication, retry, timeout and delivery behavior for the deployment you will use. Design the receiver to handle repeats and failures deliberately; this guide does not promise exactly-once delivery or a particular signing scheme.
Can I manage customer webhook subscriptions through API V1?
Customer webhook subscription management is outside the documented Engage API V1 contract. Workspace export notification configuration is a separate product surface and should not be treated as an API subscription endpoint.
This guide describes workspace capabilities and documented implementations. Availability depends on deployment, workspace configuration and the integration contract. Confirm the required features for your rollout with Shuffll.
Public API + MCP documentation ↗