Courier PHP SDK

The Courier PHP SDK provides typed access to the Courier REST API from any PHP 8.1+ application. It uses named parameters for optional arguments and returns strongly typed response objects. Available on GitHub.

The PHP SDK is currently in beta. APIs may change between releases. Share feedback or report issues on GitHub.

Installation

Install from Packagist with Composer:

composer require trycourier/courier

Requires PHP 8.1+. Find the latest version on Packagist.

Quick Start

<?php

use Courier\Client;

$client = new Client(apiKey: getenv('COURIER_API_KEY'));

$response = $client->send->message(
  message: [
    'to' => ['email' => 'you@example.com'],
    'content' => [
      'title' => 'Hello from Courier!',
      'body' => 'Your first notification, sent with the PHP SDK.',
    ],
  ],
);

var_dump($response->requestID);

Pass your API key via the COURIER_API_KEY environment variable or directly to the constructor: new Client(apiKey: 'your-key').

Authentication

Get your API key from Settings > API Keys in the Courier dashboard. Set it as an environment variable:

export COURIER_API_KEY="your-api-key"

Or pass it to the client constructor:

$client = new Client(apiKey: 'your-api-key');

Sending Notifications

With a template

$response = $client->send->message(
  message: [
    'to' => ['user_id' => 'user_123'],
    'template' => 'my-template-id',
    'data' => ['orderNumber' => '10042', 'itemName' => 'Courier Hoodie'],
  ],
);

With inline content

$response = $client->send->message(
  message: [
    'to' => ['email' => 'jane@example.com'],
    'content' => [
      'title' => 'Order shipped',
      'body' => 'Your order {{orderNumber}} has shipped!',
    ],
    'data' => ['orderNumber' => '10042'],
    'routing' => ['method' => 'single', 'channels' => ['email']],
  ],
);

Available Resources

The SDK covers the full Courier API.

Resource	Namespace	Description
Send	`$client->send`	Send messages to one or more recipients
Messages	`$client->messages`	Retrieve status, history, and content of sent messages
Profiles	`$client->profiles`	Create, update, and retrieve user profiles
Users	`$client->users`	Manage preferences, tenants, and push tokens per user
Auth	`$client->auth`	Issue JWT tokens for client-side SDK authentication
Bulk	`$client->bulk`	Send messages to large recipient lists via jobs
Lists	`$client->lists`	Manage subscription lists and their subscribers
Audiences	`$client->audiences`	Define and query audience segments
Tenants	`$client->tenants`	Manage tenants for multi-tenant setups
Journeys	`$client->journeys`	Invoke and cancel runs; create, list, publish, and archive journeys
Brands	`$client->brands`	Manage brand settings (logos, colors, templates)
Notifications	`$client->notifications`	List and inspect notification templates
Translations	`$client->translations`	Manage localized content

Common Operations

Checking Message Status

$message = $client->messages->retrieve('your-message-id');
echo $message->status;
echo $message->delivered;

Managing User Profiles

$client->profiles->create('user_123', profile: [
    'email' => 'jane@example.com',
    'phone_number' => '+15551234567',
    'name' => 'Jane Doe',
]);

$profile = $client->profiles->retrieve('user_123');

Issuing JWT Tokens

$result = $client->auth->issueToken(
  scope: 'user_id:user_123 inbox:read:messages inbox:write:events',
  expiresIn: '2 days',
);

echo $result->token;

Scope	Permission
`user_id:<id>`	Which user the token is for (required)
`inbox:read:messages`	Read inbox messages
`inbox:write:events`	Mark messages as read/archived
`read:preferences`	Read notification preferences
`write:preferences`	Update notification preferences
`write:user-tokens`	Register push notification tokens

Configuration

Error Handling

The SDK throws typed exceptions for API failures. All extend Courier\Core\Exceptions\APIException:

use Courier\Core\Exceptions\APIConnectionException;
use Courier\Core\Exceptions\RateLimitException;
use Courier\Core\Exceptions\APIStatusException;

try {
  $client->send->message(message: [
    'to' => ['user_id' => 'user_123'],
    'template' => 'my-template',
  ]);
} catch (APIConnectionException $e) {
  echo "The server could not be reached\n";
} catch (RateLimitException $e) {
  echo "Rate limited; back off a bit.\n";
} catch (APIStatusException $e) {
  echo "API error: " . $e->getMessage() . "\n";
}

Retries

The SDK automatically retries failed requests up to 2 times with exponential backoff.

// Disable retries
$client = new Client(requestOptions: ['maxRetries' => 0]);

// Or per-request
$client->send->message(
  message: ['to' => ['user_id' => 'user_123'], 'template' => 'my-template'],
  requestOptions: ['maxRetries' => 5],
);

Journeys

Journeys are multi-step workflows (send, delay, branch, throttle, digest, and more). Invoke one by ID or alias to start a run, then cancel runs by ID or a shared cancelation token.

// Start a run (by journey ID or alias); the response includes runID
$response = $client->journeys->invoke(
  templateID: 'your-journey-id',
  userID: 'user_123',
  data: ['orderId' => 'A-1042'],
);
echo $response->runID;

Cancel runs, and build and manage journeys (create, list, publish, archive), from code. When cancelling, pass exactly one of run_id or cancelation_token (spelled with one “l”). See Build journeys via API.

More Operations

The SDK covers the full Courier REST API. Here are a few more resources beyond what’s documented above:

Resource	Method	Use case
User preferences	`$client->users->preferences->retrieve($userId)`	Fetch a user’s notification preferences for your preference center
Cancel a message	`$client->messages->cancel($messageId)`	Cancel a delayed or queued message before delivery
Push tokens	`$client->users->tokens->addSingle($token, userID: $userId, providerKey: 'firebase-fcm')`	Register a device push token for iOS, Android, React Native, or Flutter

API Reference

Full REST API docs with request/response examples.

Send API

Learn about the Send endpoint, routing, and message options.

Quickstart

Send your first notification in under two minutes.

GitHub

Source code, issues, and changelog.

Client-side SDKs

Server-side SDKs

Courier PHP SDK

Installation

Quick Start

Authentication

Sending Notifications

With a template

With inline content

Available Resources

Common Operations

Checking Message Status

Managing User Profiles

Issuing JWT Tokens

Configuration

Error Handling

Retries

Journeys

More Operations

API Reference

Send API

Quickstart

GitHub

​Installation

​Quick Start

​Authentication

​Sending Notifications

​With a template

​With inline content

​Available Resources

​Common Operations

​Checking Message Status

​Managing User Profiles

​Issuing JWT Tokens

​Configuration

​Error Handling

​Retries

​Journeys

​More Operations

API Reference

Send API

Quickstart

GitHub

Installation

Quick Start

Authentication

Sending Notifications

With a template

With inline content

Available Resources

Common Operations

Checking Message Status

Managing User Profiles

Issuing JWT Tokens

Configuration

Error Handling

Retries

Journeys

More Operations