The Developer API
Create a key for code you or a developer write, choose what it may do, and revoke it when it’s done.
- The Developer API pageThe Developer API page lists your workspace’s API keys, one per row, with Open docs and Create key at the top of the card. Admins and Managers create and revoke keys; every member can read the list and the docs.
- Create an API keyOn the Developer API page, select Create key, name it, pick Full access or Read-only, and select Create key. Copy the key from its box: Jounce shows it only once.
- Full access and read-only keysA full access key can read and change your audience: add and update subscribers, move them in and out of segments, and set up webhooks. A read-only key can look at everything and change nothing.
- Revoke an API keyOn the Developer API page, an Admin or Manager selects Revoke at the end of the key’s row, then Revoke key. Anything using the key stops working right away, and a revoked key can’t be brought back.
- What the developer API can doA key lets your code read and change your subscribers, segments, and custom fields, and hear about changes through webhooks. The API follows the same rules as adding someone in Jounce.
- WebhooksA webhook tells your code the moment a subscriber joins, changes, unsubscribes, bounces, complains, or moves in or out of a segment. Your developer sets it up through the API, and Jounce signs each message.
- Why doesn’t my API key work?Usually the key was revoked, or a read-only key tried to change something. Open the Developer API page: a key that isn’t in the list is gone, and the badge on its row says which kind it is.