An intake is a webhook endpoint that accepts an HTTP request from an external system and starts a workflow run. Use intakes to connect Auxot to anything that can send an HTTP request: GitHub Actions, Zapier, your own backend, a cron job, or any CI/CD pipeline.
How Intakes Work
- You create an intake in Auxot and attach it to a workflow.
- Auxot gives you a unique webhook URL.
- Your external system sends a
POSTrequest to that URL with a JSON body. - Auxot creates a work item, runs the workflow, and (optionally) posts the result to a callback URL you provide.
Creating an Intake
Go to Settings → Intakes → Add Intake and choose the workflow to attach it to. Or ask the admin agent:
Create an intake for the "Support Ticket Triage" workflow
The admin agent will return the intake’s webhook URL.
Business and Enterprise: assign the intake to the appropriate team before saving.
Calling the Webhook
Once created, trigger the intake with a POST request. Replace INTAKE_ID with the ID shown in the intake detail view:
curl -X POST https://ai.yourcompany.com/v1/intake/INTAKE_ID \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"ticket_id": "SUP-1042", "customer": "Acme Corp", "subject": "Login error"}'
The request body can be any JSON object. The workflow receives it as the work item’s input.
Response
A successful call returns 202 Accepted immediately — the workflow runs asynchronously:
{"work_id": "work_abc123"}
Use the work_id to poll for results (see Checking Status below).
Auth
Intake webhooks require a Bearer token in the Authorization header. Two key types are accepted:
- User API key — tied to a specific user’s permissions. Begins with
user. - Team API key — tied to a team. Begins with
team.
Business and Enterprise: use a team API key for service-to-service calls so the request is scoped to the correct team. Create team keys under Settings → Teams, open the team, then Keys.
Checking Status
Poll the work item to see if the workflow has completed. Use the work_id returned from the webhook call and the same INTAKE_ID:
curl https://ai.yourcompany.com/v1/intake/INTAKE_ID/work/WORK_ID \
-H "Authorization: Bearer YOUR_API_KEY"
The response is the full work item record including status (pending, running, completed, failed), the input, and any output the workflow produced.
Callback URL
If your workflow produces a result you need delivered to an external system, set a default callback URL on the intake. When the work item completes, Auxot sends a POST with the result to that URL.
Configure the callback URL when creating or editing the intake in Settings → Intakes, or ask the admin agent:
Set the callback URL for the "Support Ticket Triage" intake to https://hooks.example.com/result
Deactivating an Intake
To stop accepting requests on a webhook URL, deactivate the intake in Settings → Intakes or ask the admin agent:
Deactivate the "Support Ticket Triage" intake
Deactivated intakes return 404 to callers without revealing that they exist.