For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact SalesGet Support
HomeGuidesAPI reference
HomeGuidesAPI reference
  • Middesk API
      • GETList webhooks
      • POSTCreate a webhook
      • GETRetrieve a webhook
      • PUTUpdate a webhook
      • DELDelete a webhook
      • GETRetrieve OIDC public keys
LogoLogo
Contact SalesGet Support
Middesk APIWebhooks

Update a webhook

PUT
https://api.middesk.com/v1/webhooks/:id
PUT
/v1/webhooks/:id
$curl -X PUT https://api.middesk.com/v1/webhooks/id \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{}'
1{
2 "object": "webhook",
3 "id": "f2a3b4c5-d6e7-8901-5678-9abcdef01234",
4 "url": "https://example.com/webhooks/middesk",
5 "enabled_events": [
6 "business.created",
7 "business.updated",
8 "order.completed"
9 ],
10 "created_at": "2025-01-07T12:00:00.000Z",
11 "updated_at": "2025-01-07T12:00:00.000Z"
12}
Was this page helpful?
Previous

Delete a webhook

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
Webhook ID

Request

This endpoint expects an object.
urlstringOptional
Webhook endpoint URL
secretstringOptional
Secret for webhook signature verification
disabled_atstringOptional
Timestamp when webhook was disabled
enabled_eventslist of stringsOptional
Array of event types to subscribe to
includestringOptional

Comma-delimited list of associations to include in webhook payloads. Omit or set to ”*” for all. Use “identifiers” to receive only top-level scalar fields (id, external_id, name, status, etc.) with no associations.

oidc_client_idstringOptional
OIDC client ID
oidc_token_endpointstringOptional
OIDC token endpoint URL
oidc_resource_uristringOptional
OIDC resource URI
oidc_access_token_ttl_secondsintegerOptional
OIDC access token TTL in seconds

Response

webhook updated

Errors

404
Update Webhook Request Not Found Error