← Help center

The Yapper API: connect your own software

The Yapper API allows you to connect external applications, CRMs, or no-code automation platforms (like Zapier, Make, or n8n) to your Yapper account. Using the API, your software can retrieve customer data, trigger actions, and keep systems in sync.

The API is structured as a REST API under the /api/v1alpha1/ path prefix. All requests are automatically scoped to your account based on your authentication credentials.

What You Can Do

The API lets you read and update runtime data. Authoring playbooks, editing phase graphs, and managing billing must be done in the dashboard.

• Senders: List your connected messaging senders (such as WhatsApp numbers or Instagram accounts) and check their details. You can also change which playbook a sender is currently using. New senders cannot be created via the API; they must be connected through the dashboard.
• Playbooks and Phases: View your playbooks and their phase definitions.
• Customers: Search and list your customers, or retrieve a specific customer profile. You can also create or look up customers by phone number (WhatsApp only).
• Lifecycles: Retrieve a customer's current phase in any playbook they have entered, list all customers within a specific playbook or phase, and move a customer to a new phase.
• Checklists: View the current live checklist state and archived snapshots for a customer.
• Notes: Read and update the free-text operator notes on a customer's profile.
• Reports: Trigger new reports for a customer, check their progress, retrieve completed reports as rendered HTML, and manage the custom memories used when generating these reports.

Getting API Credentials

To connect your software, you need to register an app in the Yapper dashboard:

1. Go to the Admin → Developer tab.
2. Click to create a new app and choose a permission scope (such as read-only, write, webhooks, or transitions).
3. The dashboard will generate a Client ID and a Client Secret.

Important: the Client Secret is only shown once and cannot be retrieved again. Store it securely. If you lose it, you must delete the app and create a new one.

Role Permissions

Only the account owner can create new apps. Both admins and the owner can view the list of registered apps and revoke (delete) them. Revoking an app immediately blocks its access.

Authentication and Limits

The API uses the OAuth 2.0 client credentials flow. Your application exchanges its Client ID and Client Secret for a short-lived access token, then sends this token as a Bearer header in the Authorization field of every subsequent API call.

Rate Limits

The API is rate-limited to ensure performance stability. If your application sends too many requests in a short window, the API will return a 429 Rate Limited status code. You should design your application to handle these errors by backing off and retrying.

Full API Reference

For detailed information on request paths, parameters, and JSON schemas, see the full API Reference on the website.