Webhooks

Retrieve all active webhooks for the authenticated workspace, both posting-scoped and workspace-scoped.

get/api/v2/webhooks

Request

  • Base URL
    https://api.heymilo.ai
  • URL
    https://api.heymilo.ai/api/v2/webhooks
  • Auth
    API key in header X-API-KEY

Query parameters

limitinteger
starting_afterstring nullable

Headers

X-API-KEYstring nullable
Authorizationstring nullable
X-Workspace-Idstring nullable

Response

Successful Response

Example response

{
  "data": [
    {
      "webhook_id": "42AE4CFA720B1C35D499E9E39C14F321",
      "posting_id": "13D77095",
      "webhook_url": "https://webhook.site/test",
      "event_type": "interview_completed",
      "created_at": 1739612400,
      "updated_at": 1739617200
    }
  ]
}

Changes

    • breaking

      the response property // became optional for the status

    • breaking

      response property data/items/posting_id list-of-types was widened by adding types null to media type application/json of response 200