Skip to main content
PATCH
Update a Webhook
Updates a webhook. Send account_id and the fields you want to change. Use it to point a webhook at a new url, change the events it receives, rotate the credentials Yuno delivers with, or deactivate it. state turns deliveries on and off: INACTIVE stops them and keeps the configuration, and ACTIVE resumes them. A rotated api_key, secret or hmac_client_secret applies to the next delivery. To remove renewal_days, send clear_renewal_days as true on its own.
Trigger fields are replaced, not merged. Send the full list of events you want the webhook subscribed to, and omit the field to leave it as it is.
The OAuth2 fields are configured as a set: when you change any of oauth2_authentication_url, oauth2_client_id, oauth2_client_secret or oauth2_grant_type, send the four of them. Renaming a webhook to a name the account already uses, or moving it onto a url where another webhook listens to one of the same events, returns 409 WEBHOOK_ALREADY_EXISTS.

Authorizations

public-api-key
string
header
default:<Your public-api-key>
required
private-secret-key
string
header
default:<Your private-secret-key>
required

Path Parameters

webhook_id
string
required

The unique identifier of the webhook, as returned by Create a Webhook.

Example:

"12345"

Body

application/json
account_id
string<uuid>
required

The unique identifier of the account the webhook belongs to.

Example:

"493e9374-510a-4201-9e09-de669d75f256"

name
string

Your name for the webhook. It must be unique within the account.

Example:

"Production payments listener"

state
enum<string>

Set it to INACTIVE to stop the deliveries while keeping the configuration, and back to ACTIVE to resume them.

Available options:
ACTIVE,
INACTIVE
Example:

"INACTIVE"

url
string

The endpoint Yuno sends the notifications to. It must be an http or https URL that resolves to a public, routable address.

Example:

"https://api.acme.com/yuno/webhooks"

api_key
string

Replaces the x-api-key Yuno sends on every delivery.

Example:

"my-webhook-key-v2"

secret
string

Replaces the x-secret Yuno sends on every delivery.

Example:

"my-rotated-secret"

hmac_client_secret
string

Replaces the key Yuno signs the payload with.

Example:

"my-rotated-hmac-secret"

oauth2_authentication_url
string

Your token endpoint. It must use HTTPS. Send oauth2_authentication_url, oauth2_client_id, oauth2_client_secret and oauth2_grant_type together.

Example:

"https://api.acme.com/oauth/token"

oauth2_client_id
string

The client identifier Yuno authenticates with. Send oauth2_authentication_url, oauth2_client_id, oauth2_client_secret and oauth2_grant_type together.

Example:

"acme_client_id"

oauth2_client_secret
string

The client secret Yuno authenticates with. Send oauth2_authentication_url, oauth2_client_id, oauth2_client_secret and oauth2_grant_type together.

Example:

"acme_client_secret"

oauth2_grant_type
string

The grant type Yuno requests the token with. Send oauth2_authentication_url, oauth2_client_id, oauth2_client_secret and oauth2_grant_type together.

Example:

"client_credentials"

oauth2_scope
string

The scope Yuno requests the token with.

Example:

"webhooks:write"

oauth2_authorization_name
string

The header Yuno sends the token in. Defaults to Authorization.

Example:

"Authorization"

oauth2_include_client_id
boolean

Send the client identifier as a header on the token request as well.

Example:

true

enrollment_triggers
enum<string>[]

Replaces the enrollment events the webhook subscribes to.

Available options:
ENROLL,
UNENROLL
Example:
payment_triggers
enum<string>[]

Replaces the payment events the webhook subscribes to.

Available options:
AUTHORIZE,
CANCEL,
CAPTURE,
CHARGEBACK,
PRECHARGEBACK,
PURCHASE,
REFUND,
VERIFY
Example:
report_triggers
enum<string>[]

Replaces the report events the webhook subscribes to.

Available options:
CREATE,
UPDATE
Example:
subscription_triggers
enum<string>[]

Replaces the subscription events the webhook subscribes to.

Available options:
ACTIVE,
CANCEL,
CLOSE_TO_RENEWAL,
COMPLETE,
CREATE,
PAUSE,
RESUME
Example:
onboarding_triggers
enum<string>[]

Replaces the onboarding events the webhook subscribes to.

Available options:
BLOCKED,
CANCELLED,
CREATED,
DECLINED,
ERROR,
EXPIRED,
INACTIVE,
PENDING,
SUCCEEDED,
TRANSFERRED,
UNBLOCKED
Example:
renewal_days
integer

How many days before a renewal Yuno sends the CLOSE_TO_RENEWAL notification. It must be 1 or more. Send it on its own, not together with clear_renewal_days.

Example:

5

clear_renewal_days
boolean

Set it to true to remove renewal_days. Send it on its own, not together with renewal_days.

Example:

true

Response

The updated webhook.

id
string

The unique identifier of the webhook.

Example:

"12345"

account_id
string<uuid>

The unique identifier of the account the webhook belongs to.

Example:

"493e9374-510a-4201-9e09-de669d75f256"

name
string

Your name for the webhook.

Example:

"Production payments listener"

state
enum<string>

ACTIVE webhooks receive notifications, INACTIVE ones do not. A webhook starts out ACTIVE.

Available options:
ACTIVE,
INACTIVE
Example:

"ACTIVE"

url
string

The endpoint Yuno sends the notifications to.

Example:

"https://api.acme.com/yuno/webhooks"

api_key
string | null

Masked as ***, or null when you have not configured it.

Example:

"***"

secret
string | null

Masked as ***, or null when you have not configured it.

Example:

"***"

hmac_client_secret
string | null

Masked as ***, or null when you have not configured it.

Example:

"***"

oauth2_authentication_url
string | null

Your token endpoint.

Example:

"https://api.acme.com/oauth/token"

oauth2_client_secret
string | null

Masked as ***, or null when you have not configured it.

Example:

"***"

oauth2_client_id
string | null

The client identifier Yuno authenticates with.

Example:

"acme_client_id"

oauth2_grant_type
string | null

The grant type Yuno requests the token with.

Example:

"client_credentials"

oauth2_scope
string | null

The scope Yuno requests the token with.

Example:

"webhooks:write"

oauth2_authorization_name
string | null

The header Yuno sends the token in.

Example:

"Authorization"

oauth2_include_client_id
boolean

Whether Yuno also sends the client identifier as a header on the token request.

Example:

true

enrollment_triggers
string[] | null

The enrollment events the webhook subscribes to.

Example:
payment_triggers
string[] | null

The payment events the webhook subscribes to.

Example:
report_triggers
string[] | null

The report events the webhook subscribes to.

Example:
subscription_triggers
string[] | null

The subscription events the webhook subscribes to.

Example:
onboarding_triggers
string[] | null

The onboarding events the webhook subscribes to.

Example:
renewal_days
integer | null

How many days before a renewal Yuno sends the CLOSE_TO_RENEWAL notification.

Example:

5

created_at
string<date-time>

The date and time the webhook was created, in ISO 8601.

Example:

"2026-07-09T13:05:36.482913Z"

updated_at
string<date-time>

The date and time the webhook was last updated, in ISO 8601. It matches created_at until you update the webhook for the first time.

Example:

"2026-07-11T16:20:44.918330Z"