Triggering Workflow
Once you've published the workflow using your Engagespot Console, it can be trigger using the send notification API itself.
You just need to specify the workflow identifier
(which you can see on your dashboard).
- Node
- cURL
- Python
- PHP
- Ruby
const { EngagespotClient } = require('@engagespot/node');
const client = EngagespotClient({
apiKey: 'YOUR_ENGAGESPOT_API_KEY',
apiSecret: 'YOUR_ENGAGESPOT_API_SECRET',
});
client.send({
notification: {
workflow: {
identifier: 'workflowIdentifier',
cancellationKey: 'yourUniqueCancellationKey',
},
},
sendTo: {
recipients: ['your-users-unique-identifier'],
},
});
curl --location --request POST 'https://api.engagespot.co/v3/notifications' \
--header 'X-ENGAGESPOT-API-KEY: YOUR_ENGAGESPOT_API_KEY' \
--header 'X-ENGAGESPOT-API-SECRET: YOUR_ENGAGESPOT_API_SECRET' \
--header 'Content-Type: application/json' \
--data-raw '{
"notification": {
"workflow": {
"identifier": "workflowIdentifier",
"cancellationKey": "yourUniqueCancellationKey"
}
},
"sendTo": {
"recipients": [
"your-users-unique-identifier"
]
}
}'
from engagespot import Engagespot
client = Engagespot(api_key='YOUR_ENGAGESPOT_API_KEY', api_secret='YOUR_ENGAGESPOT_API_SECRET')
send_request = {
"notification": {
"workflow":{
"identifier": "workflowIdentifier",
"cancellationKey": "yourUniqueCancellationKey"
}
},
"sendTo":{
"recipients": ["your-users-unique-identifier"]
}
}
client.send(send_request)
use Engagespot\\EngagespotClient;
$engagespot = new EngagespotClient('ENGAGESPOT_API_KEY', 'ENGAGESPOT_SECRET_KEY');
$notificationData = [
'notification' => [
'workflow' => [
'identifier' =>'workflowIdentifier',
'cancellationKey': 'yourUniqueCancellationKey'
],
],
'sendTo' => [
'recipients' => ['your-users-unique-identifier'],
],
];
$engagespot->send($notificationData);
engagespot = Engagespot.new(api_key: 'ENGAGESPOT_API_KEY', api_secret: 'ENGAGESPOT_SECRET_KEY')
send_request = {
notification:{
workflow: {
identifier: 'workflowIdentifier',
cancellationKey: 'yourUniqueCancellationKey'
},
},
sendTo:{
recipients: ['your-users-unique-identifier']
}
}
engagespot.send(send_request)
Inline identification of users
info
It is possible to create the users inline during a workflow trigger. Thus you can avoid creating the user beforehand. Read guide