Developer & API

Beyond the install snippet, e-satisfaction has a developer surface you can build against — a REST API, official SDKs, webhooks, and an events endpoint that automates distribution. This page is a map, not a full reference: it tells you what exists and how the pieces fit together, then points you to the developer API docs for the exact endpoints and payloads.

The REST API

The platform exposes a REST API at https://api.e-satisfaction.com (version 3.2). It speaks JSON and uses the standard verbs you'd expect — GET to read, POST to create, PATCH to update, and DELETE to remove. If you've worked with any modern REST API, it'll feel familiar.

Use it to read and manage your data programmatically — anything from pulling responses into your own systems to scripting parts of your setup.

Authentication with API tokens

The API authenticates with API tokens, which you create from your user profile under Authentication Tokens → Create new. When you create one you give it:

a title, so you can recognize it later,
an optional expiry, and
scopes — the permissions the token is allowed to use.

The token is a JWT that you copy once at creation time, so store it somewhere safe. Tokens are immutable: you can't edit a token's scopes after the fact. To change what a token can do, invalidate the old one and create a new one with the scopes you need.

Copy the token once

The JWT is shown to you a single time when you create it. If you lose it, you can't retrieve it again — you'll need to create a replacement. API keys are also covered under Admin → Security.

SDKs

To avoid hand-rolling HTTP requests, there's an official PHP SDK that wraps the API for you. It handles the request plumbing so you can call the platform in idiomatic PHP rather than building and signing requests yourself.

Webhooks

Webhooks let e-satisfaction push data to a URL you control, in real time, when a survey is completed. Instead of polling the API for new responses, you register an endpoint and the platform sends each completed response to it as it happens — ideal for feeding a CRM, a data warehouse, or a BI tool.

The exact payload and registration details live in the developer API docs; see Admin → Integrations for how integrations are managed on your side.

The Events Router

If you'd rather not build distribution logic yourself, the Events Router does it for you. Instead of deciding in your own code which survey to send and when, you send simple events — "a sale happened", "a visit happened" — to a single endpoint. e-satisfaction then applies routing rules to automatically trigger the right survey distribution.

Those routing rules are set up together with your Customer Success contact, so the logic lives on the platform side. Your job is just to emit the events; the platform handles the rest.

Let the platform route

The Events Router is the lightest way to wire up distribution: one endpoint, a couple of event types, and no branching logic in your codebase. Reach out to your Customer Success contact to define the routing rules that match your surveys.

Where the full reference lives

Everything on this page is an orientation. For the exact endpoints, request and response shapes, scope names, and webhook payloads, head to the developer API docs — this page is the map that tells you which territory to look in.

Security

Manage API keys and tokens, and control who can do what.

Integrations

Connect e-satisfaction to your other tools, including webhook destinations.

Pushing metadata

Attach context to responses from the front end with updateMetadata.

Data bridges

Move recipient and response data between e-satisfaction and your systems.