Skip to content

Deel: Update a webhook

Deel webhooks.updateWebhook: arguments, response, policy and SDK examples.

← Webhooks operations · Get started

Operation deel.webhooks_updatewebhook

Provider route: PATCH /webhooks/{id}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["webhooks"]["updateWebhook"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.webhooks.updateWebhook(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.webhooks.update_webhook(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.idstringRequired within parent
bodyobjectOptional
body.descriptionstring or nullOptionalWebhook subscription description.
body.eventsarrayOptionalReplaces the list of events enabled for this subscription. Retries scheduled for removed events are cancelled.
body.events[]stringEach item
body.include_child_orgsboolean or nullOptionalWhen true, the webhook will also receive events from child organizations.
body.namestringOptionalWebhook subscription name.
Maximum length: 128
body.statusstringOptionalStatus of webhook.
One of: enabled, disabled
body.urlstringOptionalEndpoint to receive webhook. Must use https.

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Create a webhook — 201 response body

Referenced models: Create a webhook — 201 response body

Create a webhook — 201 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create a webhook — 201 response body — data
The webhook subscription.

Referenced models: Create a webhook — 201 response body — data

Create a webhook — 201 response body — data
FieldTypePresenceDescription and constraints
$objectRootThe webhook subscription.
api_versionstringRequired within parentDeel API version. Currently Deel accepts v1 or v2.
Default: v2
created_atstringRequired within parentTime at which the webhook was created.
deleted_atJSONOptional
deleted_at (anyOf 1)stringAlternativeTime at which the webhook was deleted.
deleted_at (anyOf 2)nullAlternativeTime at which the webhook was deleted.
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeWebhook subscription description.
description (anyOf 2)nullAlternativeWebhook subscription description.
eventsarrayRequired within parentThe list of events to enable for this subscription.
events[]stringEach item
hiddenJSONOptional
hidden (anyOf 1)booleanAlternativeWhether to hide the webhook from the frontend view (commonly used by Deel third-party apps).
hidden (anyOf 2)nullAlternativeWhether to hide the webhook from the frontend view (commonly used by Deel third-party apps).
idstringRequired within parentUnique identifier of this resource.
include_child_orgsJSONOptional
include_child_orgs (anyOf 1)booleanAlternativeWhen true, the webhook will also receive events from child organizations.
include_child_orgs (anyOf 2)nullAlternativeWhen true, the webhook will also receive events from child organizations.
internalbooleanOptionalIndicates whether the webhook is internal to Deel.
nameJSONRequired within parent
name (anyOf 1)stringAlternativeWebhook subscription name.
name (anyOf 2)nullAlternativeWebhook subscription name.
signing_keyJSONRequired within parent
signing_key (anyOf 1)stringAlternativeThe webhook's signing key, used to generate webhook signatures.
signing_key (anyOf 2)nullAlternativeThe webhook's signing key, used to generate webhook signatures.
statusstringRequired within parentStatus of webhook.
Known values: enabled, disabled
updated_atstringRequired within parentTime at which the webhook was updated.
urlstringRequired within parentEndpoint to receive webhook.

SDK function policy ID: deel.webhooks_updatewebhook. Catalog operation: webhooks/update. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["webhooks:write"]

Pinned headers: {"X-Version": "2026-01-01"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.