Quickstart

This guide will get you up and running with Taskhook in less than 5 minutes. We'll cover how to create your first background task and verify its execution through our dashboard.

Create your first task

Let's create a simple task that makes a POST request to a test endpoint. This example demonstrates the core Taskhook workflow: you submit a task with a callback URL, and Taskhook handles the execution.

curl https://api.taskhook.io/v1/tasks \
  -H "Authorization: Bearer {your_api_key}" \
  -d target="https://postman-echo.com/post" \
  -d payload='{"message": "Hello from Taskhook!"}'

After submitting this request, you'll receive a response containing the task ID and status:

{
  "id": "task_123",
  "status": "queued",
  "target": "https://postman-echo.com/post",
  "payload": {
    "message": "Hello from Taskhook!"
  },
  "created_at": "2024-02-01T12:00:00Z"
}

Monitor your task

Visit the Taskhook Console to monitor your task's execution. You'll see:

• The task's current status
• Execution attempts and results
• Response data from the callback URL
• Detailed execution logs

What's next?

Now that you've created your first task, here are some next steps to explore Taskhook's capabilities:

• Schedule delayed tasks with execute_after
• Configure retries for reliability
• Set up rate limiting for your callbacks
• Create task queues for ordered processing