Create a webhook

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

urlstringRequired

Webhook endpoint URL

enabled_eventslist of stringsRequired

Array of event types to subscribe to, or [”*”] for all events

secretstringOptional

Secret for webhook signature verification

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 created with wildcard events

Errors

422

Create Webhook Request Unprocessable Entity Error

$	curl -X POST https://api.middesk.com/v1/webhooks \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"url": "https://example.com/webhooks/middesk",
>	"enabled_events": [
>	"business.created",
>	"business.updated",
>	"order.completed"
>	],
>	"secret": "whsec_abcdef123456"
>	}'

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	}

$	curl -X POST https://api.middesk.com/v1/webhooks \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"url": "https://example.com/webhooks/middesk",
>	"enabled_events": [
>	"business.created",
>	"business.updated",
>	"order.completed"
>	],
>	"secret": "whsec_abcdef123456"
>	}'

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	}