---
title: "Update a webhook"
method: PUT
path: "/api/tenants/{tenantId}/webhooks/{webhookId}"
tags: ["Webhooks"]
---

# Update a webhook

`PUT /api/tenants/{tenantId}/webhooks/{webhookId}`

## Path parameters

- `tenantId` integer, required
- `webhookId` string, required

## Request body

- Webhook — The Webhook API object
  - `id` integer — The unique object id (immutable)
  - `status` 'Active' | 'Inactive' — The object status
  - `created` string, date-time — The date which the API object was created (immutable)
  - `updated` string, date-time — The date which the API object was last updated (immutable)
  - `name` string, required — The payroll name
  - `receiverAddress` string, required — The webhook receiver address
  - `action` 'None' | 'CaseFunctionRequest' | 'CaseChangeAdded' | 'PayrunFunctionRequest' | 'PayrunJobProcess' | 'PayrunJobFinish' | 'ReportFunctionRequest' | 'TaskChange', required — The Webhook message type
  - `attributes` object, nullable — Custom attributes

## Response `200`

Success

- Webhook — The Webhook API object
  - `id` integer — The unique object id (immutable)
  - `status` 'Active' | 'Inactive' — The object status
  - `created` string, date-time — The date which the API object was created (immutable)
  - `updated` string, date-time — The date which the API object was last updated (immutable)
  - `name` string, required — The payroll name
  - `receiverAddress` string, required — The webhook receiver address
  - `action` 'None' | 'CaseFunctionRequest' | 'CaseChangeAdded' | 'PayrunFunctionRequest' | 'PayrunJobProcess' | 'PayrunJobFinish' | 'ReportFunctionRequest' | 'TaskChange', required — The Webhook message type
  - `attributes` object, nullable — Custom attributes

## Other responses

- `404` — Not Found
- `422` — Client Error

## Changes

- **2023-07-23** `fd1b5146be4a` — 24 warning, 110 info
  - removed the optional property `additionalProperties/errors/items/exception/targetSite/customAttributes/items/constructor/module/assembly/definedTypes/items/isFunctionPointer` from the response with the `422` status
  - removed the optional property `additionalProperties/errors/items/exception/targetSite/customAttributes/items/constructor/module/assembly/definedTypes/items/isUnmanagedFunctionPointer` from the response with the `422` status
  - removed the optional property `additionalProperties/errors/items/exception/targetSite/declaringType/assembly/definedTypes/items/isFunctionPointer` from the response with the `422` status
  - removed the optional property `additionalProperties/errors/items/exception/targetSite/declaringType/assembly/definedTypes/items/isUnmanagedFunctionPointer` from the response with the `422` status
  - …130 more

[Change history](https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1/changes/api/tenants/:tenantId/webhooks/:webhookId/put.md)

---

[API](https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1.md) · [All operations](https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1/revisions/fd1b5146be4a?raw)