Webhooks

Project Created (Webhook Callback)

BugHerd sends this POST request to your registered target_url whenever a new project is created in your organization. The payload contains the full project object. Your server should respond with any 2xx status code to acknowledge receipt.

postWebhookproject_create

Payload

Example payload

{
  "project": {
    "id": 1000,
    "name": "My Website",
    "created_at": "2011-02-06 23:43:07",
    "tasks": true,
    "devurl": "https://www.example.com",
    "is_active": true,
    "owner_name": "Alan Downie",
    "sites": [
      "http://bugherd.com/"
    ],
    "api_key": "your-project-api-key",
    "allow_guests_change_task_status": true,
    "assign_guests": true,
    "allow_project_summary_email": true,
    "allow_task_done_email": true,
    "members": [
      {
        "id": 4561,
        "email": "jane@example.com",
        "display_name": "Jane Smith",
        "avatar_url": "https://bugherd.com/avatars/jane.png"
      }
    ],
    "guests": [
      {
        "id": 4561,
        "email": "jane@example.com",
        "display_name": "Jane Smith",
        "avatar_url": "https://bugherd.com/avatars/jane.png"
      }
    ],
    "columns": [
      {
        "id": 55,
        "name": "In Review",
        "project_id": 1000,
        "position": 2,
        "tasks_count": 31,
        "created_at": "2020-03-24T02:48:35.340Z",
        "updated_at": "2020-03-24T02:48:35.340Z"
      }
    ]
  }
}

Response

Webhook acknowledged

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.