Kixie Automations
This article covers the steps to create an automation in HighLevel that will trigger an action in Kixie.
You will need to send a request to the Kixie API directly.
Create Workflow
- Click "+ Create Workflow" to create a new Workflow. Then choose the "Start from scratch" option and click Continue to start building.
- Now you will need to decide what you will use to trigger this workflow. Click on "Add New Trigger" to select your trigger.
- Some common examples of Workflow triggers include: Contact Created, Contact Changed, or Inbound Webhook.
For this example, I am going to use the "Contact Changed" trigger with the Assigned User has changed to my agent profile.
- Once you have finalized your trigger, click "Save Trigger".
- Next, click on the "+" sign to add your next action step.
- For this action, please select the "Custom Webhook" action.
- Next you will need to start inputting the fields for the Custom Webhook step.
- Action Name - You can give it any name
- Event - CUSTOM
- Method - POST
- URL - https://apig.kixie.com/app/event?apikey=<api-key-here>
- Authorization - None
Kixie Actions
In the Body, this is where you will specify which type of Kixie Action you will want to use. Each action will require a different data object. The URL will be the same.
Kixie: Add to PowerList
If you are going to be adding a contact to a Powerlist, please copy and paste this in the Webhook's Raw Body.
{
"businessid": "<business-id-here>",
"powerlistId": "<powerlist-id>",
"apikey": "<api-key-here>",
"target": "{{contact.phone}}",
"eventname": "updatepowerlist",
"firstName": "{{contact.first_name}}",
"lastName": "{{contact.last_name}}",
"companyName": "{{contact.company_name}}",
"email": "{{contact.email}}",
"extraData": {
"anyData": "<data-value-here>"
}
}
"businessid" (required) - Found in the Kixie Dashboard under Manage > Account Settings
"powerlistId" (required) - Found in the Kixie Dashboard under Manage > Powerlists
"apikey" (required) - Found in the Kixie Dashboard under Manage > Account Settings
"target" (required) - This is the phone number that is associated with the contact you will be adding to the Powerlist. You will need to use the {{contact.phone} syntax.
- This is essentially just accessing the "Phone" property on the Contact module. You can similarly use this for any property that exists on the Contact.
"eventname" (required) - Make sure that this is set to "updatepowerlist"
"firstName" (optional) - "{{contact.first_name}}"
-
- This will access the first_name property on the Contact module.
"lastName" (optional) - "{{contact.last_name}}"
-
- This will access the last_name property on the Contact module.
"title", "companyName", and "email" (optional) - These can all be accessed the same way that you would access the first name and last name from the Contact module.
"extraData" (optional) - This is an object that you can add up to 6 custom fields. You can use any existing properties on the Contact by using the same syntax {{contact}}.
Kixie: Send Auto-SMS
If you are going to be sending an Auto-SMS, please copy and paste this in the Webhook's Raw Body.
{
"businessid": "<business-id-here>",
"email": "<kixie-agent-email>",
"target": "{{contact.phone}}",
"eventname": "sms",
"message" : "Hello World",
"apikey": "<api-key-here>"
}
"businessid" (required) - Found in the Kixie Dashboard under Manage > Account Settings
"apikey" (required) - Found in the Kixie Dashboard under Manage > Account Settings
"target" (required) - This is the phone number that is associated with the contact you will be sending the SMS message to. You will need to use the {{contact.phone}} syntax.
- This is essentially just accessing the "Phone" property on the Contact module. You can similarly use this for any property that exists on the Contact.
"eventname" (required) - Make sure that this is set to "sms".
"message" (required) - This is the message body of the SMS that you are going to be sending.
"email" (required) - This is the email of the Kixie Agent that you will be sending the SMS from. Kixie will use the Outbound SMS number that is associated with this agent.
Save and Publish
Click Save on the action and then Publish the workflow.