webhooks

Create a webhook

The signing secret is returned once. The URL is checked against the SSRF guard at registration and again at delivery.

post/v1/webhooks

Request

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

Request body

urlstring uri required

Example request

{
  "url": "https://example.com/hooks/hyperresearch"
}

Response

Created

idstring required
urlstring required
eventsstring[] required

The wire values this endpoint is subscribed to. * means every event.

activeboolean required
created_atstring required
dead_deliveriesinteger required

How many deliveries to this endpoint gave up after exhausting their retries (1 m, 5 m, 30 m, 2 h, 12 h). These are gone: nothing re-sends them. GET /v1/webhooks/{id}/deliveries lists them with the status each attempt got back.

secretstring required

Example response

{
  "id": "wh_01J9ZQ7V6H0000000000000000",
  "secret": "whsec_…"
}

Changes

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