Remove a webhook endpoint

​

Stops new deliveries and excludes the endpoint from List webhook endpoints. A delivery already in progress may still reach the endpoint. Removing an endpoint that is already absent returns 204.

OAuth scopes
  • webhooks:write

Path Parameters

  • webhookEndpointId
    Type: string
    min length:  
    1
    max length:  
    200
    required

    PayrollKit webhook endpoint ID.

Headers

  • Idempotency-Key
    Type: string
    min length:  
    16
    max length:  
    200
    required

    Identifies one write for safe retries. Reuse it only for the same method, URL, content type and body and, when present, the same If-Match value and acting-user headers. PayrollKit retains the result for 30 days, then treats a request using the same key as new.

  • X-Request-Id
    Type: stringFormat: uuid

    Client-generated UUID for tracing. This does not make retries safe.

Responses

  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
delete/webhook-endpoints/{webhookEndpointId}
No Body

Webhook endpoint removed or already absent