Getting Started

To search using the REST API, you’ll need an API key with the correct permissions. Go to Admin > Tech Hub > REST API and follow these steps:

1. Create an Administrator Key
2. Ensure the Administrator Key has the Trigger responders permission
3. Activate your Administrator Key

Triggering the Responder

To trigger the Responder, you'll be making a JSON Post to the URL below:

https://helpcentre.leadbyte.com/restapi/v1.3/responders/trigger

With the following body:

{
	"key": "[API KEY GOES HERE]",
	"leadId": 1234,
	"responderId": 4567
}

You’ll find the Lead ID beside each lead on the Leads page.
The Responder ID is located under Responders > Select > Edit. Your responder will need to be created, saved and enabled to trigger. The Responder ID will only show once it has been created. 
Trigger setting needs to be: Manually using REST API.
 

Successful Response

{
	"status": "Success",
	"message": "See push results",
	"warnings": [
	],
	"pushResults": [
		{
			"responderId": "123",
			"pushId": "456",
			"queued": true,
			"status": "Queued",
			"leadId": 1234
		}
	]
}

FAQs

Can I trigger multiple Responders at once?

Sure thing, replace the single Responder ID with the below: 

"responders": [
		123,
		124
	]

Can I trigger a specific Push on my Responder?

You can replace the Responder ID with "pushId"; this ID can be found under Responders > Select & Edit. Here you will see a list of your pushes with the required push ID: