Deel: Create a webhook

← webhooks operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation deel.webhooks_createwebhook

Provider route: POST /webhooks. Alter supplies the connection’s credentials and routing.

Call through Alter

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"]["createWebhook"]>[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.createWebhook(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.create_webhook(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	object	Optional
body.api_version	string	Required within parent	Deel API version. Only v2 is accepted. Default: v2
body.description	string or null	Required within parent	Webhook subscription description.
body.events	array	Required within parent	The list of events to enable for this subscription.
body.events[]	string	Each item
body.include_child_orgs	boolean or null	Optional	When true, the webhook will also receive events from child organizations.
body.name	string or null	Required within parent	Webhook subscription name.
body.signing_key	string or null	Optional	The webhook’s signing key, used to generate webhook signatures. Auto-generated if omitted. Maximum length: 128 Minimum length: 32
body.status	string	Required within parent	Status of webhook. One of: enabled, disabled
body.url	string	Required within parent	Endpoint to receive webhook.

Response

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

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Create a webhook — 201 response body

Referenced models: Create a webhook — 201 response body

Policy, approvals and errors

SDK function policy ID: deel.webhooks_createwebhook. Catalog operation: webhooks/create. 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