Suggested readings: Test API for On API Call Starter, Preview and Test Message
Testing is performed by launching the journey in Active status and sending test users through the On API Call starter. Transactional Journeys does not have a Testing status.
The goal is to confirm:
The On API Call is correctly configured.
Test users enter the journey successfully.
Messages are delivered as expected.
After successful testing, the same journey continues to process real users without changes.
Before starting the test, make sure that:
The journey is fully configured on the canvas.
All channel content is complete and ready.
The journey passes validation without errors.
The journey is switched to Active status.
Draft and Sunset journeys cannot receive API-triggered requests.
Step 1: Activate the journey
Once you create your transactional journey with the On API Call starter and add channel elements to create the content, launch it in the Active status.
Once active, the journey immediately starts accepting API requests.
For further information about testing, refer to Test API for On API Call starter and Preview and Test Message.
Step 2: Prepare test users
Use identifiers that are safe for testing, such as internal email addresses, test phone numbers, test IID, or UUID values.
Step 3: Send a test API request
Send a real API request to the On API Call endpoint targeting the active journey.
The journey must be active; otherwise, the request is rejected.
Each request must include a unique idempotency_key.
Below is a sample payload.
{
"idempotency_key": "appointment-98765-reminder",
"targets": [
{
"type": "journey_id",
"value": 1001
}
],
"users": [
{
"identifier": {
"type": "iid",
"value": "5083a0db-756c-4fe1-989c-a6a39051a89d"
},
"dynamic_attributes": {
"appointment": {
"id": "98765",
"date": "2025-01-15",
"time": "14:30",
"location": "Main Clinic - Room 204",
"doctor": {
"name": "Dr. Emily Carter",
"department": "Dermatology"
}
},
"patient": {
"first_name": "Alex",
"last_name": "Johnson"
}
}
}
]
}Step 4: Confirm the test
After the request is accepted:
Users enter the journey immediately.
Channel messages are sent within the SLA (service level agreement).
To confirm that the test worked:
Verify the message was received by the test user.
Check Live Statistics to confirm the user entered the journey.
Review analytics pages (e.g., Journey, SMS/Email Analytics) to see delivery metrics.
If test users don’t enter the journey, switch the journey to Passive to block new entries while troubleshooting the On API Call payload.