Custom Webhook API
Integrate any tool, any workflow.
1. Create a Webhook from Your Dashboard
- Navigate to the Webhooks section in your Trailpad dashboard
- Click "Create Webhook" and give it a name
- Select the project to associate activities with
- Copy the generated webhook URL and token
Security Note: Keep your webhook URL and token secure. Anyone with access to the URL can send activity data to your Trailpad account.
2. Send Activity Data
Send a POST request to your webhook URL with a JSON payload containing the activity data.
The Activity Object
| Field | Type | Required | Description |
|---|---|---|---|
| title | string | Yes | Short title of the activity |
| description | string | No | Detailed description of the activity |
| startTime | ISO 8601 | Yes | When the activity started |
| endTime | ISO 8601 | No | When the activity ended |
| trigger | string | No | The source or trigger of the activity |
| event | string | No | Event type (e.g. push, merge, resolve) |
| memberEmail | string | Yes | Email of the team member |
| externalId | string | No | ID from the external system |
| metadata | object | No | Additional key-value data |
Example with cURL
curl -X POST https://api.trailpad.ai/webhooks/your-webhook-id \
-H "Content-Type: application/json" \
-H "Authorization: Bearer your-webhook-token" \
-d '{
"title": "Deployed v2.1.0 to production",
"description": "Merged PR #142 and deployed to production servers",
"startTime": "2025-07-01T14:30:00Z",
"endTime": "2025-07-01T14:45:00Z",
"trigger": "GitHub Actions",
"event": "deployment",
"memberEmail": "dev@company.com",
"externalId": "deploy-142",
"metadata": {
"environment": "production",
"version": "2.1.0"
}
}'