Help CenterGitHub

Create a webhook

Creates a new webhook endpoint to receive real-time event notifications.

Parameters

Request Body

name string Required
Friendly name for the webhook endpoint
url string Required
HTTPS URL that will receive webhook POST requests
event_types array Required
Events to subscribe to (use "all" for all events)
description string
Optional description for reference
is_active boolean
Whether the webhook is active
retry_attempts integer
Number of retry attempts on failure (0-10)
timeout integer
Request timeout in seconds (5-60)
auth_type string (none | basic | bearer | custom)
Authentication method for your endpoint
auth_config object
Authentication credentials (depends on auth_type)
custom_headers object
Additional HTTP headers to include in requests

Returns

201 Webhook created successfully
400 Validation error
401 Authentication required

Related

Webhooks
POST/api/v1/webhooks
atoship © 2026