Docs

API Reference

Getting Started

Pushfire provides a comprehensive set of API endpoints that allow you to seamlessly integrate your applications with the Pushfire platform. Through these endpoints, you can efficiently manage your audience by creating, updating, and organizing subscribers, defining segments to target specific groups, and assigning tags to enrich subscriber profiles with additional context or attributes.

This API-first approach ensures that your applications can programmatically interact with Pushfire, enabling automation, personalization, and scalable audience management for notifications, campaigns, and user engagement.

Register Device

Register a new device for push notifications and create an anonymous subscriber.

Endpoint URL

POST https://api.pushfire.app/functions/v1/register-device

Authentication

Authorization: Bearer YOUR_PUSHFIRE_PROJECT_API_TOKEN

Include your API token in the Authorization header

Bearer Token

Request Body

Content-Typeapplication/json

Response Examples

200 Success

Update Device

Update an existing device's information.

Endpoint URL

PATCH https://api.pushfire.app/functions/v1/update-device

Authentication

Authorization: Bearer YOUR_PUSHFIRE_PROJECT_API_TOKEN

Include your API token in the Authorization header

Bearer Token

Request Body

Content-Typeapplication/json

Response Examples

200 Success

Login Subscriber

Login a subscriber and replace the anonymous subscriber associated with a device.

Endpoint URL

POST https://api.pushfire.app/functions/v1/login-subscriber

Authentication

Authorization: Bearer YOUR_PUSHFIRE_PROJECT_API_TOKEN

Include your API token in the Authorization header

Bearer Token

Request Body

Content-Typeapplication/json

Response Examples

200 Success

Update Subscriber

Update an existing subscriber's information.

Endpoint URL

PATCH https://api.pushfire.app/functions/v1/update-subscriber

Authentication

Authorization: Bearer YOUR_PUSHFIRE_PROJECT_API_TOKEN

Include your API token in the Authorization header

Bearer Token

Request Body

Content-Typeapplication/json

Response Examples

200 Success

Logout Subscriber

Logout a subscriber and recreate an anonymous subscriber for the device.

Endpoint URL

POST https://api.pushfire.app/functions/v1/logout-subscriber

Authentication

Authorization: Bearer YOUR_PUSHFIRE_PROJECT_API_TOKEN

Include your API token in the Authorization header

Bearer Token

Request Body

Content-Typeapplication/json

Response Examples

200 Success

Add Tag to Subscriber

Adds a tag to a subscriber by creating the association between the user and the specified tag. The tag can exist on its own or optionally include an associated value (e.g., "plan": "premium").

Endpoint URL

POST https://api.pushfire.app/functions/v1/add-subscriber-tag

Authentication

Authorization: Bearer YOUR_PUSHFIRE_PROJECT_API_TOKEN

Include your API token in the Authorization header

Bearer Token

Request Body

Content-Typeapplication/json

Response Examples

200 Success

Update Tag Value to Subscriber

Update the value of a tag for a subscriber.

Endpoint URL

PATCH https://api.pushfire.app/functions/v1/update-subscriber-tag

Authentication

Authorization: Bearer YOUR_PUSHFIRE_PROJECT_API_TOKEN

Include your API token in the Authorization header

Bearer Token

Request Body

Content-Typeapplication/json

Response Examples

200 Success

Remove Tag to Subscriber

Remove a tag from a subscriber.

Endpoint URL

DELETE https://api.pushfire.app/functions/v1/remove-subscriber-tag

Authentication

Authorization: Bearer YOUR_PUSHFIRE_PROJECT_API_TOKEN

Include your API token in the Authorization header

Bearer Token

Request Body

Content-Typeapplication/json

Response Examples

200 Success

Execute Workflow

Create a new workflow execution for immediate or scheduled delivery.

Endpoint URL

POST https://api.pushfire.app/functions/v1/create-workflow-execution

Authentication

Authorization: Bearer YOUR_PUSHFIRE_PROJECT_API_TOKEN

Include your API token in the Authorization header

Bearer Token

Request Body

Content-Typeapplication/json

Response Examples

200 Success