ARN Smart Support
Language: English

REST API keys and signed webhooks (Pro)

Updated 5 Nov 2026 4 min read

Feedback saved.

Browse Contix articles

Contix Pro offers scoped REST API keys and signed webhooks, so other systems can start work in Contix and hear when it finishes. Both work only after an administrator creates them.

Where to find it: ARN Contix → System → Integrations. Choose the project context at the top and click Open integration workspace. The Google Search Console connection on the same screen is described in Track performance with Google Search Console.

Contix Integrations screen with REST API scopes, the Search Console connection and signed webhook settings, with no keys shown

Create a REST API key

  1. Under 1. REST API Keys, enter a Name.
  2. Under Project binding, choose All projects or one project. A key bound to one project works only with requests that name that project (project_id), and cannot create projects. A bound key can also call GET /status, and GET /projects returns only its own project.
  3. Tick the Scopes the key needs.
  4. Click Create API key.

The new key is shown once: copy it right away and store it safely. Contix stores keys only as salted hashes and cannot show a key again.

The key table lists the Name, the key Prefix, the Scopes and when the key was Last used. Click Revoke to stop a key; requests that use it are refused from then on.

Scopes and endpoints

All endpoints are under /wp-json/contix/v1/. Send the key in the Authorization header as Bearer followed by the key.

Method and endpointScopeWhat it does
GET /statussystem.readReturns the Contix version, the schema and whether the runtime is paused
GET /projectsprojects.readLists projects; for a key bound to one project, only that project
POST /projectsprojects.writeCreates a project (name, language, region, brand_summary, content_goal)
GET /projects/{project_id}/topicstopics.readLists the topics of a project
POST /projects/{project_id}/topicstopics.writeCreates a topic (keyword, secondary_keywords, content_type, search_intent, audience, language, region, goal, priority)
POST /pipeline/startpipeline.writeStarts a run (project_id, topic_id, mode as automatic or guided)
GET /pipeline/{run_id}?project_id={project_id}pipeline.readReturns the status of a run
GET /projects/{project_id}/topics/{topic_id}/resultsresults.readReturns the saved results of a topic, such as the article draft, analysis and publishing package
GET /projects/{project_id}/jobsjobs.readLists the recent jobs of a project
GET /projects/{project_id}/connectorsconnectors.readLists the connectors of a project

Each key is limited to 120 requests per minute. Common answers:

StatusMeaning
401The key is missing, invalid or revoked
403The key does not grant this scope, it is bound to another project, or a bound key tried to create a project
409The run could not start; the message gives the reason
422The project or topic could not be created; check the fields
429The key exceeded 120 requests per minute

Every authenticated request is written to the Contix log.

Create a signed webhook

  1. Under 3. Signed Webhooks, enter a Name and the HTTPS endpoint.
  2. Tick the Events you want: job.completed, job.failed, pipeline.completed, pipeline.failed, publish.completed or publish.failed.
  3. Click Create webhook.

The signing secret is shown once: copy it right away. Only public HTTPS addresses are accepted; private and reserved network addresses are refused.

The webhook table shows the events, the number of successful and failed deliveries and the last status. Click Delete to remove a webhook.

Verify a webhook delivery

Contix sends each event as a JSON POST with these headers:

HeaderContent
X-Contix-EventThe event type, for example pipeline.completed
X-Contix-DeliveryA stable delivery ID; use it to ignore a delivery you already processed
X-Contix-TimestampThe time of the delivery as a Unix timestamp
X-Contix-Signaturev1= followed by the signature

The signature is an HMAC-SHA256, in hexadecimal, of the timestamp, a full stop and the raw request body (timestamp.body), with your signing secret as the key. Compute it on your side and compare it with the header before you trust the request.

A delivery counts as successful when your endpoint answers with a 2xx status. Network errors and answers with status 429 or 5xx are retried through the queue. Redirects are not followed.

On this page

Submit a ticket

Create a new support request without needing a portal account.

Priority
Attachments
Only you and our staff see a ticket. Never send passwords or licence codes.

Track a ticket

Use the ticket number and password from your confirmation email.

The number and the password are in your confirmation email.

Sign in

Access your support portal account.

New here?

Create account

Create your support portal account.

Already have an account?

Forgot password?

We email you a link to choose a new password.

Conversation

Was this helpful?
Open full article
↑ ↓ to moveEnter to openEsc to close