User APIs
Written by Medha Anand
Updated on December 13th, 2021
- Getting Started
- Bot Building
- Smart Agent Chat
- Conversation Design
-
Developer Guides
Code Step Integration Static Step Integration Shopify Integration SETU Integration Exotel Integration CIBIL integration Freshdesk KMS Integration PayU Integration Zendesk Guide Integration Twilio Integration Razorpay Integration LeadSquared Integration USU(Unymira) Integration Helo(VivaConnect) Integration Salesforce KMS Integration Stripe Integration PayPal Integration CleverTap Integration Fynd Integration HubSpot Integration Magento Integration WooCommerce Integration Microsoft Dynamics 365 Integration
- Deployment
- External Agent Tool Setup
- Analytics & Reporting
- Notifications
- Commerce Plus
- Troubleshooting Guides
- Release Notes
[HOOK] Create user
If supported by the ECT, the create user API allows the creation of a new user (case, etc.) in the ECT. This is to facilitate easy mapping of user IDs etc between a third party middleware (FB, WA, etc.), the ECT, and Haptik.
Endpoint
type |
POST |
required |
false |
provider |
ECT (via register_webhook) |
caller |
TRACT |
url |
registered_webhooks[user_events][create_user] |
encoding |
application/json |
Request
| parameter | type | required | description |
|---|---|---|---|
| user_id | str | true | User ID within Haptik |
| third_party_user_id | str | false | User ID on a third party / social platform (eg: FB/WA) |
| user_name | str | false | User's name |
| device_platform | str | false | User's device platform |
| details_available | List[dict] | false | List of additional details available on request. Varies per user. |
Response
| parameter | type | required | description |
|---|---|---|---|
| success | bool | true | Acknowledgment from ECT |
| ect_user_id | str | false | User ID in the ECT |
[API] Get user
In case user messages are received before the user creation event is triggered, ECT can call this endpoint to fetch the user.
Endpoint
type |
POST |
required |
false |
provider |
TRACT |
caller |
ECT |
url |
/tract/user/ |
encoding |
application/json |
Request
| parameter | type | required | description |
|---|---|---|---|
| user_id | str | true | User ID within Haptik (available with the message received) |
Response
| parameter | type | required | description |
|---|---|---|---|
| user_id | str | true | User ID within Haptik |
| third_party_user_id | str | false | User ID on a third party / social platform (eg: FB/WA) |
| user_name | str | false | User's name |
| device_platform | str | false | User's device platform |
| details_available | List[str] | false | List of additional details available on request |
[API] Get user details
Additional user details that are not provided as part of the base user information can be fetched using this endpoint.
Endpoint
type |
POST |
required |
false |
provider |
TRACT |
caller |
ECT |
url |
/tract/user/details/ |
encoding |
application/json |
Request
| parameter | type | required | description |
|---|---|---|---|
| user_id | str | true | User ID within Haptik |
| details_requested | List[str] | true | List of additional details requested. See response of /tract/user API above to determine available details that can be fetched. |
Response
| parameter | type | required | description |
|---|---|---|---|
| user_id | str | true | User ID within Haptik |
| details | dict | true | Additional details in a JSON format |
