README

This is PHP SDK for Quake. The Quake platform provides WhatsApp and SMS message flow capabilities useful for recruitment, lead qualification and other automated two-way communication.

Visit the Quake website for more information.

Installation

You can install the package via composer:

composer require mralston/quake-sdk

Basic Usage

use Mralston\Quake\Client;
use Mralston\Quake\Contact;
use Mralston\Quake\Flow;

// Log in
$client = new Client(
    $username,
    $password,
    $companyId,
    $apiEndpoint
);

// Create contact
$contact = $client->createContact(
    $firstName,
    $lastName,
    $mobileNumber
)

// Delete contact
$client->deleteContact($contact);

// Create flow instance
$flowInstance = $client->createFlowInstance(
    $flow,
    $contact,
    $parameters
);

// Fetch flow instance by ID
$flowInstance = $client->showFlowInstance($id);

// Invite a flow instance (trigger the flow)
$client->inviteFlowInstance($flowInstance);

// Fetch all flow instances
foreach ($client->listFlowInstances() as $flowInstance) {
    dump($flowInstance);
}

// Fetch all flows
foreach ($client->listFlows() as $flow) {
    dump($flow);
}

// Fetch all entities
foreach ($client->listEntities() as $entity) {
    dump($entity);
}

Fluent API

Many of the objects exposed by the API support method chaining.

$client->createContact(
    $firstName,
    $lastName,
    $mobileNumber
)->createFlowInstance(
    Flow::make(['id' => $flowId])
)->invite();

Webhooks

The Quake platform can send push notifications to your application via webhooks. In order to use webhooks, your application must be able to respond to the challenge requests sent to it. Such challenges include a crc_token which must be combined with a signing key secret in order to send a valid response. Signing keys can be set up on the Quake website.

The resolveWebhookChallenge() method on the Quake client will take care of generating this response for you. All you need to do is provide it with the crc_token received and send back the response. Here is a basic example:

$client = new Client(
    $username,
    $password,
    $companyId,
    $apiEndpoint,
    $webhookSecret
);

$crcToken = $_GET['crc_token'];
$response = $client->resolveWebhookChallenge($crcToken);

echo $response;

Laravel

Configuration

In Laravel, you can publish the config file with:

php artisan vendor:publish --provider="Mralston\Quake\QuakeServiceProvider" --tag="config"

This is the contents of the published config file:

return [
    'username' => env('QUAKE_USERNAME'),
    'password' => env('QUAKE_PASSWORD'),
    'company_id' => env('QUAKE_COMPANY_ID'),
    'api_endpoint' => env('QUAKE_API_ENDPOINT'),
    'webhook_secret' => env('QUAKE_WEBHOOK_SECRET')
];

Configure the three environment variables with your username, password and company ID. These are UUIDs supplied by Quake. The API endpoint is the base URL of the Quake platform, for example https://www.quake.co.uk.

QUAKE_USERNAME=
QUAKE_PASSWORD=
QUAKE_COMPANY_ID=
QUAKE_API_ENDPOINT=
QUAKE_WEBHOOK_SECRET=

Dependency Injection

In addition to the method chaining described in the fluent API section above, the Laravel integration takes care of authentication automatically. All you need to do is grab an instance of the client from the container and start using it.

You can use dependency injection to get a pre-authenticated instance of the client:

use Illuminate\Http\Request;
use Mralston\Quake\Client;

class MyController
{
    public function create(Request $request, Client $client)
    {
        // Create new contact using POST data
        $contact = $client->createContact(
            $request->input('first_name'),
            $request->input('last_name'),
            $request->input('mobile'),
        )
    }
}

Alternatively, you can resolve an instance of the client from the container:

use Mralston\Quake\Client;

$client = app(Client::class);

Facade

In true Laravel tradition, you can also use a facade (along with method chaining, of course!).

use Mralston\Quake\Facades\Quake;
use Mralston\Quake\Flow;

Quake::createContact(
    $firstName,
    $lastName,
    $mobileNumber
)->createFlowInstance(
    Flow::make(['id' => $flowId])
)->invite();

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

mralston / quake-sdk

Maintainers

Details