Sendoso helps organisations to build real relationships and reward employees at scale with their Sending Platform.
This document describes steps to enable OAuth2 authentication and how to send gifts using Sendoso API through Enboarder. You will need to be a Sendoso customer and administrator to complete the integration. For more information see https://sendoso.com/hr-and-more-teams/
Setting up the Sendoso Tile
Here are the steps for Integration:
- Login as admin user and go to Settings → Integration → App centre
- Click on the tile Sendoso (or search if you can't see it) for which you want the integration setup.
- Click on Add Integration button:
- On next screen, enter the env prefix. Sendoso have 3 env, please enter right prefix and click next
Production Environment: app
- On next screen, click on Integrate Now button
The system will redirect you to Sandoso site, enter your Sendoso credential.
Once logged in, request for information access will be asked. Once this is allowed, the customer instance will be setup, and the integration is completed.
The system will show tile as integrated:
Send a e-gift using web hook
Basic information required to send a gift
Before sending a gift using api, please login your Sendoso account and note down below information
- TouchID
- Amount allocated to touch
Login in your account and go to https://app.sendoso.com/touches
Click on Edit and you will find the TouchID in URL. Copy the URL as below:
Then click on next step button to see next page. In this page, please note down the amount of gift.
There are two options. Either there will be default amount:
or range of amount for gift:
In second case the value of amount should be either Minimum or Maximum
Gifts API
Sending e-gift to single recipient
URL - https://app.sendoso.com/api/v3/send.json
Sample Payload:
Please change the amount and touch id based on requirements.
{
"send": {
"via": "single_email_address",
"amount": 25,
"touch_id": 4856,
"via_from": "{{direct_manager_email}}",
"email": "{{newhire_email}}",
"custom_message": "Hi {{newhire_name}}, Here is your coffee coupon"
}
}Note- The custom_message is optional.
Response:
On Successful you will get below response
{
"success": true,
"message": "EGifts send Successfully",
"tracking_code": "c65f6ef000a889efc64cd133f204e47175a4d416",
"tracking_url": "https://staging.sendoso.com/track/c65f6ef000a889efc64cd133f204e47175a4d416"
}Sending e-gift to multiple recipients
URL - https://staging.sendoso.com/api/v3/send/bulk_email_addresses
Sample Payload:
Please change the amount and touch id based on requirements.
{
"send":
{
"via": "bulk_email_addresses",
"touch_id": 4853,
"amount": 5,
"via_from": "{{direct_manager_email}}",
"message_from": "CSV",
"recipient_users":
[
{
"first_name": "{{newhire_name}}", "email": "{{newhire_email}}", "custom_message": "Hi {{newhire_name}}, here is coupon for coffie"
},
{
"first_name": "{{buddy_name}}", "email": "{{buddy_email}}", "custom_message": "Hi {{buddy_name}}, here is your Starbuck coupon"
}
]
}
}Note- The custom_message is optional.
Response:
On Successful you will get below response
{
"success": true,
"message": "Bulk coffee sending in progress, this may take a little time. You'll see it in Activity shortly."
}Sending physical gift to recipient
URL - https://staging.sendoso.com/api/v3/send.json
Sample Payload:
Please change the amount and touch id based on requirements.
{
"send": {
"via": "single_person_or_company",
"touch_id": "1076",
"name": "{{newhire_name}}",
"address": "{{form / welcomeform / address}}",
"address1": "{{form / welcomeform / address1}}",
"city": "{{form / welcomeform / city}}",
"state": "{{form / welcomeform / state}}",
"country": "{{form / welcomeform / country}}",
"zip": "{{form / welcomeform / zip}}",
"via_from": "{{manager_name}}",
"email": "{{newhire_email}}",
"custom_message": "Hi {{newhire_name}}, Happy remote onboardering, here is your welcome kit..."
}
}Note- The custom_message is optional.
Response:
On Successful you will get below response
{
"success": true,
"message": "Gifts send Successfully",
"tracking_code": "c65f6ef000a889efc64cd133f204e47175a4d416",
"tracking_url": "https://staging.sendoso.com/track/c65f6ef000a889efc64cd133f204e47175a4d416"
}Webhook setting
While configuring web-hook, please select authentication as Sendoso and remove any additional header/key row
References
Authorisation with OAuth2 flow
https://sendoso.docs.apiary.io/#introduction/the-api/authorizing-your-connection
Send Gift
https://sendoso.docs.apiary.io/#reference/send-management/send-a-gift/sending-a-gift
Send Gift to multiple recipients
https://sendoso.docs.apiary.io/#reference/send-management/bulk-sending/send-a-bulk-group-of-e-gifts
How to create a touch
https://sendoso.zendesk.com/hc/en-us/articles/115006881487-How-to-create-a-Touch