Start guide

Connect ingests partner events, runs durable workflows, and lets operators decide waiting work in the portal. This guide covers the three first-success paths.

Partner — post a signed event

Use this when an external system should start work without logging into Authentik.

1. An operator registers a webhook app on Portal Webhooks → Apps and copies the HMAC secret (shown once).
2. Sign the raw request body with HMAC-SHA256 and send X-Partner-Signature: sha256=<hex>.
3. POST to https://connect.intronsoft.com/api/v1/webhooks/partners/{appId}/events.
4. First accept returns 202. The event appears on Webhooks → Events. A matching catalog workflow starts under the same correlation id.

BODY='{"eventType":"contact.lead","externalId":"lead-1001","data":"{\"email\":\"ada@example.com\"}"}'
SIG=$(echo -n "$BODY" | openssl dgst -sha256 -hmac "$HMAC_SECRET" | awk '{print $2}')

curl -sS -D - -o /tmp/connect-webhook.json \
  -X POST "https://connect.intronsoft.com/api/v1/webhooks/partners/acme/events" \
  -H "Content-Type: application/json" \
  -H "X-Partner-Signature: sha256=$SIG" \
  -d "$BODY"

Full header contract: Sign requests.

Operator — review a waiting task

Use this when a workflow is waiting on a person.

1. Sign in to the management portal.
2. Open Tasks. Waiting runs with an operator prompt appear here.
3. Open the run, or act from the composer: Approve, Reject, or Submit form data.
4. The run graph marks the taken exit. Approve on contact-lead creates a Plane issue. Reject or timeout skips Plane; the run still Completed.

Integrator — read leads with an API key

Use this when another product needs approved leads.

1. An operator creates a consumer on Portal Consumers and grants contact-leads.
2. Copy the API key once.
3. Call Experience APIs with X-API-KEY.

curl -sS \
  -H "X-API-KEY: $CONNECT_API_KEY" \
  "https://connect.intronsoft.com/api/v1/leads?limit=10"

What you will see

Next

• Concepts — how the objects compose
• Sign requests — HMAC details
• Try the API — OpenAPI playground