SENDO JOURNEY API
Send notification by 2 distinct channels in one call. Example: The firts attempt will be trough channel PUSH and if it not arrive - failover -be sent by SMS
Execute a Journey
POSThttps://api.sendo.cloud/api/journey
This endpoint executes a journey.
Required Fields
| Field | Type | Description | Example |
|---|---|---|---|
| context | object | Context Object | |
| smsEncript | boolean | Indicates if the SMS message should be encrypted. | true |
| smsPriority | number | Indicates the priority of the SMS message. | 1 |
| smsValidPeriod | number | Indicates the validity period of the SMS message. | 30 |
| event | string | Name of the event to execute the journey. | |
| properties | object | This is an extension of the person object that can have custom properties. | { "balance": "Enterprise", "type": "PRE", "name": "Jasson" } |
| timestamp | string | Timestamp of the request | |
| person | object | User of the Journey, See Person Definition Also can be used as variable |
| Code | Description |
|---|---|
| 200 | OK |
{
"messageId": "fed3fdfc-5fc6-456e-95b7-298a899dab87",
"message": "Journey queued"
}| Code | Description |
|---|---|
| 404 | Not Found |
{
"message": "The journey does not exist",
"error": "Not Found",
"statusCode": 404
}Definitions
Person
| Field | Type | Description | Example |
|---|---|---|---|
| id | string | User's external identifier | |
| deviceToken | string | Application's device token for push notifications | |
| string | |||
| firstName | string | Also can be used as variable | |
| language | string | Also can be used as variable | |
| lastName | string | Also can be used as variable | |
| phone | string | User's phone number, including the country code. Also can be used as variable | 593999999999 |
Journey Workflow
Event Entry
Users enter journeys with Event Entry Nodes immediately when they send a TRACK event with the specified name. Event Entry Nodes are useful for what might traditionally considered transactional messaging. For example, journeys with Event Entry Nodes are appropriate for sending order confirmation, password reset, or order cancellation emails. With every matching event, a new instance of the journey is created for the user.