Skip to content
C CountdownFlow Help Center Sign in

Using the API for automation

Learn to create API keys, authenticate requests, and manage automation within the platform.

3 min read

Screenshots use fictional demo data. Your controls may differ by plan, role, or environment. Use the values generated in your own workspace.

Generating limited-scope keys

  1. 1The workspace owner opens API & webhooks when the plan includes the capability.
  2. 2Create a named key to ensure its purpose remains recognizable. Select Read for reporting or Read and write only if your integration needs to modify records.
  3. 3Copy the generated token into your server’s secure secret storage. Keys are stored as hashes; store your own secure copy as you cannot retrieve the original token later.
  4. 4Assign a unique key to each integration and revoke keys that are no longer in use.
API and webhook management screen without exposed credentials
Create keys and endpoints from this screen when your plan and role permit it. Store keys and signing secrets only on your server. View full-size screenshot (opens in a new tab)

Authenticating within the target workspace

Include the key in an Authorization: Bearer header via HTTPS. Never embed the key in browser client-side code, URL query strings, or public repositories. Requests operate with the permissions of the member who created the key, and workspace membership and role checks occur on every call.

Use the base URL provided in the API & webhooks section. The official public API resides at /api/v1; the Replit preview supports /app/api/v1. Access the OpenAPI document at /api/v1/openapi.json or via the preview alias at /app/api/v1/openapi.json.

curl --request GET \ "https://YOUR_DOMAIN/api/v1/campaigns" \ --header "Accept: application/json" \ --header "Authorization: Bearer YOUR_SERVER_SIDE_API_KEY"

Automation capabilities

  • List, create, read, update and delete permitted campaigns using the documented endpoints.
  • Publish, pause, resume or duplicate through the documented campaign action routes.
  • Read campaign analytics and manage supported phase/behavior configuration.
  • List or create supported landing pages according to the schema.
  • Use explicit timezone offsets for timestamps and the exact enum values shown in OpenAPI.

Error and rate limit handling

Evaluate the response status and validation body rather than relying on HTTP redirects as proof of success. Expect errors regarding unauthenticated credentials, forbidden membership/scope/feature access, missing or inaccessible records, invalid input, or throttling.

The current limit is 120 requests per minute per key; additional inbound protection may apply. If you receive an HTTP 429, follow the retry guidance and implement backoff. Do not create additional keys to circumvent rate limits.

Review the current schema before sending updates. A replacement list can overwrite earlier values; an empty phase list deletes existing phases and should only be used when pairing with the intended enabled state. Treat DELETE and publication actions as definitive changes and perform testing against separate test campaigns.

Related articles