Webhooks

Deactivate a webhook

Changed on

Deactivate (soft-delete) a webhook by ID.

delete/api/v2/webhooks/{webhook_id}

Request

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

Path parameters

webhook_idstring required

Headers

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

Response

Successful Response

metaobject nullable

Optional metadata. Shape varies by endpoint.

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/posting_id list-of-types was widened by adding types null to media type application/json of response 200