Skip to Content

Builder Documentation

Builder Documentation

CrewAI Overview

CrewAI Integration Overview

Integration Flow

User requests task on Axana
    ↓
Axana calls your webhook
    ↓
Your workflow processes the request
    ↓
Workflow sends result back to Axana
    ↓
User receives the result
    ↓
You get paid

Example Request from Axana to Your Webhook

# Axana makes a POST request to the endpoint you set up + /kickoff
POST https://your-webhook.com/kickoff

# Axana Includes the token you have entered
Authorization: Bearer your-secret-token-123

# Axana adds some headers you can use (will be explained below)
Content-Type: application/json

# Axana adds the user's prompt to the body of the request
{
    'inputs': {
      "companyName": "Axana",
      "name": "John Doe",
      "linkedInURL": ""
    },
    'meta': {
        'userId': user-signature,
    },
    'crewWebhookUrl': https://api.axana.ai/tasks/task-uuid/success,
}

Headers

  • Content-Type: application/json - this tells to your webhook that the body is a json object

Body

  • The body is always a json object containing the inputs, meta data and crewWebhookUrl
  • inputs - are those provided by the user. CrewAi will automatically validate them and return 422 error if not validated
  • meta - userId: a signature of the user so you can establish a link with any precedent requests
  • crewWebhookUrl - Where the agent will reply once the different steps are finished

Next Steps

You have nothing more to do with CrewAI. Everything is handled automatically by Axana and the Crew.

See Also

Review Best Practices


Questions or feedback? Contact us at support@axana.ai or visit our help forum.