v1

latestOpenAPI 3.0.02026-07-26167441.9 MB

Update a Webhook

Updates a webhook. Send only the fields you want to change, including the state and any rotated secret.

patch/webhooks/{webhook_id}

Path parameters

webhook_idstring required

Example:12345

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

Request body

account_idstring uuid required

The unique identifier of the account the webhook belongs to.

namestring

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

state'ACTIVE' | 'INACTIVE'

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

urlstring

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

api_keystring

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

secretstring

Replaces the x-secret Yuno sends on every delivery.

hmac_client_secretstring

Replaces the key Yuno signs the payload with.

oauth2_authentication_urlstring

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

oauth2_client_idstring

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

oauth2_client_secretstring

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

oauth2_grant_typestring

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

oauth2_scopestring

The scope Yuno requests the token with.

oauth2_authorization_namestring

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

oauth2_include_client_idboolean

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

enrollment_triggersstring[]

Replaces the enrollment events the webhook subscribes to.

payment_triggersstring[]

Replaces the payment events the webhook subscribes to.

report_triggersstring[]

Replaces the report events the webhook subscribes to.

subscription_triggersstring[]

Replaces the subscription events the webhook subscribes to.

onboarding_triggersstring[]

Replaces the onboarding events the webhook subscribes to.

renewal_daysinteger

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.

clear_renewal_daysboolean

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

Example request

{
  "account_id": "493e9374-510a-4201-9e09-de669d75f256",
  "name": "Production payments listener",
  "state": "INACTIVE",
  "url": "https://api.acme.com/yuno/webhooks",
  "api_key": "my-webhook-key-v2",
  "secret": "my-rotated-secret",
  "hmac_client_secret": "my-rotated-hmac-secret",
  "oauth2_authentication_url": "https://api.acme.com/oauth/token",
  "oauth2_client_id": "acme_client_id",
  "oauth2_client_secret": "acme_client_secret",
  "oauth2_grant_type": "client_credentials",
  "oauth2_scope": "webhooks:write",
  "oauth2_authorization_name": "Authorization",
  "oauth2_include_client_id": true,
  "enrollment_triggers": [
    "ENROLL"
  ],
  "payment_triggers": [
    "AUTHORIZE",
    "CAPTURE",
    "REFUND"
  ],
  "report_triggers": [
    "UPDATE"
  ],
  "subscription_triggers": [
    "CREATE",
    "CANCEL"
  ],
  "onboarding_triggers": [
    "CREATED",
    "SUCCEEDED"
  ],
  "renewal_days": 5,
  "clear_renewal_days": true
}

Response

The updated webhook.

idstring

The unique identifier of the webhook.

account_idstring uuid

The unique identifier of the account the webhook belongs to.

namestring

Your name for the webhook.

state'ACTIVE' | 'INACTIVE'

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

urlstring

The endpoint Yuno sends the notifications to.

api_keystring

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

secretstring

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

hmac_client_secretstring

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

oauth2_authentication_urlstring

Your token endpoint.

oauth2_client_secretstring

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

oauth2_client_idstring

The client identifier Yuno authenticates with.

oauth2_grant_typestring

The grant type Yuno requests the token with.

oauth2_scopestring

The scope Yuno requests the token with.

oauth2_authorization_namestring

The header Yuno sends the token in.

oauth2_include_client_idboolean

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

enrollment_triggersstring[]

The enrollment events the webhook subscribes to.

payment_triggersstring[]

The payment events the webhook subscribes to.

report_triggersstring[]

The report events the webhook subscribes to.

subscription_triggersstring[]

The subscription events the webhook subscribes to.

onboarding_triggersstring[]

The onboarding events the webhook subscribes to.

{"stackTrail":"components:schemas:Webhook:properties:renewal_days","oasType":"schema","type":"unknown","description":"How many days before a renewal Yuno sends the `CLOSE_TO_RENEWAL` notification.","example":5}

created_atstring date-time

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

updated_atstring 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 response

{
  "id": "12345",
  "account_id": "493e9374-510a-4201-9e09-de669d75f256",
  "name": "Production payments listener",
  "state": "ACTIVE",
  "url": "https://api.acme.com/yuno/webhooks",
  "api_key": "***",
  "secret": "***",
  "hmac_client_secret": "***",
  "oauth2_authentication_url": "https://api.acme.com/oauth/token",
  "oauth2_client_secret": "***",
  "oauth2_client_id": "acme_client_id",
  "oauth2_grant_type": "client_credentials",
  "oauth2_scope": "webhooks:write",
  "oauth2_authorization_name": "Authorization",
  "oauth2_include_client_id": true,
  "enrollment_triggers": [
    "ENROLL",
    "UNENROLL"
  ],
  "payment_triggers": [
    "AUTHORIZE",
    "CAPTURE",
    "REFUND"
  ],
  "report_triggers": [
    "UPDATE"
  ],
  "subscription_triggers": [
    "CREATE",
    "CLOSE_TO_RENEWAL"
  ],
  "onboarding_triggers": [
    "CREATED",
    "SUCCEEDED"
  ],
  "renewal_days": 5,
  "created_at": "2026-07-09T13:05:36.482913Z",
  "updated_at": "2026-07-11T16:20:44.918330Z"
}