Skip to content

Deel: Send a simulated webhook event

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

← Webhooks operations · Get started

Operation deel.webhooks_simulatewebhookbyid_v2026_10_28

Provider route: POST /webhooks/{webhook_id}/simulate. 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"]["simulateWebhookById"]>[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.simulateWebhookById(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.simulate_webhook_by_id(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.webhook_idstringRequired within parent
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true
bodyobjectOptional
body.dataModelRequired within parentExpand Send a simulated webhook event — request body — body data
The event to simulate.

Referenced models: Send a simulated webhook event — request body — body data

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Send a simulated webhook event — 200 response body

Referenced models: Send a simulated webhook event — 200 response body

Send a simulated webhook event — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Send a simulated webhook event — 200 response body — data

Referenced models: Send a simulated webhook event — 200 response body — data

Send a simulated webhook event — request body — body data
FieldTypePresenceDescription and constraints
$objectRootThe event to simulate.
event_typestringRequired within parentName of the event type to simulate. The webhook must be subscribed to it.
Send a simulated webhook event — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
deliveryJSONRequired within parentThe delivery attempt made to your endpoint, or null when no delivery was made.
delivery (anyOf 1)ModelAlternativeExpand Send a simulated webhook event — 200 response body — data / delivery / status: success, failed
delivery (anyOf 2)nullAlternative
is_successbooleanRequired within parentTrue when your endpoint accepted the delivery.

Referenced models: Send a simulated webhook event — 200 response body — data / delivery / status: success, failed

Send a simulated webhook event — 200 response body — data / delivery / status: success, failed
FieldTypePresenceDescription and constraints
$objectRootThe delivery attempt made to your endpoint, or null when no delivery was made.
attempt_idJSONRequired within parent
attempt_id (anyOf 1)JSONAlternative
attempt_id (anyOf 1) (anyOf 1)integerAlternativeUnique identifier of the delivery attempt.
attempt_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
attempt_id (anyOf 2)nullAlternativeUnique identifier of the delivery attempt.
duration_msJSONRequired within parent
duration_ms (anyOf 1)JSONAlternative
duration_ms (anyOf 1) (anyOf 1)integerAlternativeTime your endpoint took to answer, in milliseconds.
duration_ms (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
duration_ms (anyOf 2)nullAlternativeTime your endpoint took to answer, in milliseconds.
response_status_codeJSONRequired within parent
response_status_code (anyOf 1)JSONAlternative
response_status_code (anyOf 1) (anyOf 1)integerAlternativeHTTP status code your endpoint answered with, or null when it did not answer.
response_status_code (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
response_status_code (anyOf 2)nullAlternativeHTTP status code your endpoint answered with, or null when it did not answer.
statusstringRequired within parentOutcome of the delivery attempt.
Known values: success, failed

SDK function policy ID: deel.webhooks_simulatewebhookbyid_v2026_10_28. Catalog operation: webhooks_simulatewebhookbyid_v2026_10_28. 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-10-28"}

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.