webhooks

Webhook event catalogue

Every event a webhook can subscribe to, with the human name and one sentence explaining when it fires. The event value is what goes in events on POST /v1/webhooks; label is what a picker shows. Additive: a client must ignore an event it does not recognise rather than failing.

get/v1/webhooks/events

Request

  • Base URL: https://api.hyperresearch.ai
  • URL: https://api.hyperresearch.ai/v1/webhooks/events
  • Auth: one of:
    • HTTP bearer
    • API key in cookie hr_session

Response

Events

Example response

{
  "data": [
    {
      "event": "run.done",
      "label": "Run finished"
    }
  ]
}

Changes

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