API and Webhooks

Overview

The API tab allows you to request API credentials for your account and create webhook notifications

API

Sakari has a RESTful API. Please see our developer docs for details.

To request your API credentials: 

  • Go to Settings > Account Settings
  • Select the API tab
  • Click the Generate button
  • You will receive: 
    • Account Id - your Sakari ID
    • Client Id - your Sakari client ID
    • Client Secret - your Sakari client secret 

Webhook

To create a new Sakari webhook: 

  • In the left navigation select Settings > Account Settings
  • Select the API tab
  • Click the Create Webhook button
  • Select your preferred webhook triggering criteria
  • Select your destination URL
  • Click Save
Screen_Shot_2023-05-19_at_5.56.13_PM.png
 

Webhook triggers:

Message Received - triggered when a new message is received from a contact

Message Sent - triggered when a new message is sent from a contact

Message Status - triggered when a message status changes

Contact Created - triggered when a contact is created in Sakari

Contact Updated  - triggered when a contact is updated in Sakari

Contact Removed  - triggered when a contact is deleted in Sakari

Contact Opt Out - triggered when a contact opts-out of text messaging 

Contact Opt In - triggered when a contact opts-in to text messaging 

Conversation Started - triggered when a new conversation is created with a contact

Conversation Closed - triggered when a conversation is closed with a contact

 

Screen_Shot_2023-05-19_at_5.56.51_PM.png