Webhooks

Create Webhook

Creates a new webhook subscription. When the specified event occurs, BugHerd sends a POST request to your target_url with the relevant payload.

Supported events: project_create, task_create, task_update, comment, task_destroy. Create separate webhook entries for each event type you want to monitor.

Project scope: Omit project_id to receive events for all projects.

Auto-removal: A 410 Gone response from your target URL will cause BugHerd to automatically remove the webhook.

post/api_v2/webhooks.json

Request

  • Base URL: https://www.bugherd.com
  • URL: https://www.bugherd.com/api_v2/webhooks.json
  • Auth: HTTP basic

Request body

target_urlstring uri required

The endpoint that will receive the webhook POST

event'project_create' | 'task_create' | 'task_update' | 'comment' | 'task_destroy' required
project_idinteger

Scope the webhook to a specific project. Omit for all projects.

Response

Created webhook

Example response

{
  "webhook": {
    "id": 22649,
    "target_url": "https://app.example.com/api/bugherd_sync/task_create",
    "event": "task_create",
    "project_id": 1000,
    "success_count": 25161,
    "error_count": 21052,
    "last_error_code": 404,
    "last_error_at": "2026-03-26T00:39:45.720Z",
    "first_error_at": "2020-12-03T06:17:10.456Z",
    "first_success_at": "2020-02-13T05:01:06.203Z",
    "last_success_at": "2026-03-12T04:39:37.627Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.