Webhooks

Disable a webhook subscription

Permanently disable a subscription and cancel its undelivered work. Rendering and artifact finalization are independent of this operation.

DELETE/api/v2/webhooks/{webhookId}

Required scopewebhooks.write

Parameters

webhookId

pathstring<uuid>required

Owner-scoped outbound webhook subscription identifier.

Request body

This operation does not accept a request body.

Operational behavior

Idempotency

Mode: resource idempotent. No idempotency header is required.

Retries

Repeat DELETE for the same subscription ID. An already-disabled subscription is a successful idempotent outcome. Retry statuses: 429, 503. Honor Retry-After.

Retention

Disablement is permanent and timestamped. Pending and leased deliveries are cancelled; already-sent requests remain subject to receiver deduplication. Response field: subscription.disabledAt.

Responses

200The disabled subscription.

Response headers

X-Correlation-Id

Response schema

WebhookResponse

Webhook Response object used by the Publishing API.

contractVersion

stringrequired

Contract Version value.

secret

objectoptional

Secret value.

subscription

objectrequired

Subscription value.

200 example

{
  "contractVersion": "publishing.lifecycle.v1",
  "subscription": {
    "createdAt": "2026-07-20T15:00:00.000Z",
    "currentSecretFingerprint": "9a7c1e204f63d8b2",
    "currentSecretVersion": 2,
    "description": "Production publishing events",
    "disabledAt": "2026-07-20T15:20:00.000Z",
    "endpoint": "https://hooks.example.com/markdowntopdf",
    "eventTypes": [
      "job.succeeded",
      "job.failed",
      "job.cancelled"
    ],
    "id": "55555555-5555-4555-8555-555555555555",
    "status": "disabled",
    "updatedAt": "2026-07-20T15:20:00.000Z"
  }
}

401The bearer credential is missing, malformed, expired, revoked, or belongs to the wrong environment.

Response headers

X-Correlation-Id

Response schema

PublishingErrorEnvelope

Publishing Error Envelope object used by the Publishing API.

contractVersion

stringrequired

Contract Version value.

error

objectrequired

Error value.

401 example

{
  "contractVersion": "publishing.lifecycle.v1",
  "error": {
    "category": "authentication",
    "code": "unauthorized",
    "httpStatus": 401,
    "message": "A valid API key is required.",
    "retryable": false
  }
}

403The principal is authenticated but lacks the operation's required scope.

Response headers

X-Correlation-Id

Response schema

PublishingErrorEnvelope

Publishing Error Envelope object used by the Publishing API.

contractVersion

stringrequired

Contract Version value.

error

objectrequired

Error value.

403 example

{
  "contractVersion": "publishing.lifecycle.v1",
  "error": {
    "category": "authorization",
    "code": "forbidden",
    "httpStatus": 403,
    "message": "The API key does not have the required scope.",
    "retryable": false
  }
}

404The resource does not exist or is not visible to this principal. Cross-tenant misses use the same response.

Response headers

X-Correlation-Id

Response schema

PublishingErrorEnvelope

Publishing Error Envelope object used by the Publishing API.

contractVersion

stringrequired

Contract Version value.

error

objectrequired

Error value.

404 example

{
  "contractVersion": "publishing.lifecycle.v1",
  "error": {
    "category": "authorization",
    "code": "not_found",
    "httpStatus": 404,
    "message": "The requested resource was not found.",
    "retryable": false
  }
}

429The request is temporarily rate limited. No final publication unit is consumed.

Response headers

X-Correlation-IdRetry-After

Response schema

PublishingErrorEnvelope

Publishing Error Envelope object used by the Publishing API.

contractVersion

stringrequired

Contract Version value.

error

objectrequired

Error value.

429 example

{
  "contractVersion": "publishing.lifecycle.v1",
  "error": {
    "category": "entitlement",
    "code": "rate_limited",
    "details": {
      "retryAfterSeconds": 30
    },
    "httpStatus": 429,
    "message": "Too many publishing requests. Retry after 30 seconds.",
    "retryable": true
  }
}

503A transient publishing, queue, renderer, or storage dependency is unavailable. No failed render consumes a final publication unit.

Response headers

X-Correlation-IdRetry-After

Response schema

PublishingErrorEnvelope

Publishing Error Envelope object used by the Publishing API.

contractVersion

stringrequired

Contract Version value.

error

objectrequired

Error value.

503 example

{
  "contractVersion": "publishing.lifecycle.v1",
  "error": {
    "category": "internal",
    "code": "service_unavailable",
    "details": {
      "retryAfterSeconds": 30
    },
    "httpStatus": 503,
    "message": "Publishing is temporarily unavailable.",
    "retryable": true
  }
}

Request

curl --request DELETE \
  "https://markdowntopdfconverter.com/api/v2/webhooks/${WEBHOOK_ID}" \
  -H "Authorization: Bearer $MD2PDF_API_KEY"

Response

200 The disabled subscription.

{
  "contractVersion": "publishing.lifecycle.v1",
  "subscription": {
    "createdAt": "2026-07-20T15:00:00.000Z",
    "currentSecretFingerprint": "9a7c1e204f63d8b2",
    "currentSecretVersion": 2,
    "description": "Production publishing events",
    "disabledAt": "2026-07-20T15:20:00.000Z",
    "endpoint": "https://hooks.example.com/markdowntopdf",
    "eventTypes": [
      "job.succeeded",
      "job.failed",
      "job.cancelled"
    ],
    "id": "55555555-5555-4555-8555-555555555555",
    "status": "disabled",
    "updatedAt": "2026-07-20T15:20:00.000Z"
  }
}