Hooks

Create project webhook

Registers a new webhook endpoint for the project. Provide the desired event and HTTPS target URL; optionally include a secret for request signing.

post/v1/projects/{projectId}/hooks

Request

  • Base URL: https://api.ybug.io
  • URL: https://api.ybug.io/v1/projects/{projectId}/hooks
  • Auth: HTTP bearer

Request body

eventstring required

Event that triggers the webhook. Currently, only feedback.created is supported per project.

target_urlstring uri required

HTTPS endpoint that receives the webhook payload.

secretstring

Optional shared secret used to sign webhook payloads.

Example request

{
  "event": "feedback.created",
  "target_url": "https://example.com/webhook",
  "secret": "MYSECRETTOKEN"
}

Response

Webhook successfully created.

idstring uuid
eventstring
target_urlstring uri
activeboolean
created_atstring date-time

Example response

{
  "id": "019a77e7-5105-774f-ac0b-1b9b18f8366a",
  "event": "feedback.created",
  "target_url": "https://example.com/webhook",
  "active": true,
  "created_at": "2025-11-12T11:50:39.000Z"
}

Changes

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