Managing Webhooks

Webhooks allow you to receive real-time HTTP POST notifications when events happen in your Filoxenos account. You can manage your webhook endpoints via the API or in the dashboard.

GET/webhooks

Lists all configured webhook endpoints.

Scopewebhooks

Example Response

json

{
  "data": [
    {
      "id": "whk_12345",
      "url": "https://your-app.com/api/webhooks/filoxenos",
      "events": [
        "checkin.completed",
        "sync.error"
      ],
      "status": "active",
      "created_at": "2026-01-01T12:00:00Z"
    }
  ]
}

POST/webhooks

Registers a new webhook endpoint.

Scopewebhooks

Request Body

Parameter	Type	Description
`url`Required	string	The HTTPS URL where Filoxenos will send event payloads.
`events`Required	array	List of event types to subscribe to (e.g., ["*"] for all).
`description`	string	Internal description for this endpoint.

Signing Secret

When you create a webhook, the response will contain a secret field. This secret is shown **only once**. Store it securely to verify incoming signatures.

Example Creation Response

json

{
  "id": "whk_67890",
  "url": "https://your-app.com/webhooks",
  "events": [
    "*"
  ],
  "secret": "whsec_a1b2c3d4e5f6g7h8i9j0",
  "status": "active"
}

PATCH/webhooks/:id

Updates an existing webhook endpoint configuration.

Scopewebhooks

Parameter	Type	Description
`url`	string	Update the destination URL.
`events`	array	Update the subscribed events.
`rotate_secret`	boolean	Set to true to regenerate the signing secret.

DELETE/webhooks/:id

Permanently deletes a webhook endpoint.

Scopewebhooks