Deactivate a webhook

Deactivate (soft-delete) a webhook by ID.

DELETE /api/v2/webhooks/{webhook_id}

Deactivate a webhook

cURL

curl --request DELETE \
  --url https://api.heymilo.ai/api/v2/webhooks/{webhook_id} \
  --header 'X-API-KEY: <api-key>'

200

{
  "data": {
    "webhook_id": "<string>",
    "posting_id": "<string>",
    "url": "<string>",
    "event_type": "<string>",
    "is_active": true,
    "created_at": 123,
    "updated_at": 123,
    "object": "webhook"
  },
  "meta": {}
}

Authorizations

X-API-KEY · string · header · required

API key for authentication. Pass your key in the X-API-KEY header.

Headers

X-API-KEY · string | null

Authorization · string | null

X-Workspace-Id · string | null

Path Parameters

webhook_id · string · required

Response

200

application/json

Successful Response

data · WebhookResponse · object · required

A webhook configuration.

Show child attributes

meta · Meta · object

Optional metadata. Shape varies by endpoint.