Skip to main content
POST
Create a webhook
For webhook verification and retry behavior, see the Webhooks guide.

Authorizations

Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json
events
string[]
required

Webhook events to include in the webhook subscription.

name
string
required

Your name for the webhook subscription.

url
string<uri>
required

Where you want to receive webhook delivery. This can be either a backend URL that you manage, or a URL provided by a webhook management service. Argyle handles URL encoding for webhook URLs. Send the URL in its normal, unencoded form.

secret
string

Optional secret used to verify webhooks.

config
object

Optional event-specific configuration for the webhook subscription. (Only applicable to certain webhooks)

Response

200 - application/json
id
string<uuid>

ID of the webhook subscription.

name
string

Name of the webhook subscription.

events
string[]

Webhook events included in the webhook subscription.

config
object

Event-specific configuration for the webhook subscription.

secret
string | null

Secret used to verify webhooks, if provided.

url
string<uri>

URL where webhook deliveries are sent.

created_at
string<date-time>

Time when the webhook subscription was created.

updated_at
string<date-time>

Time when the webhook subscription was last updated.

last_sent_at
string<date-time> | null

Last time Argyle sent the webhook. A null value means the webhook has not been sent.