v1

latestOpenAPI 3.0.02026-07-26167441.9 MB

Retrieve a Webhook

Returns a webhook by its unique identifier, with its secrets masked.

get/webhooks/{webhook_id}

Path parameters

webhook_idstring required

Example:12345

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

Query parameters

account_idstring uuid required

Example:493e9374-510a-4201-9e09-de669d75f256

The unique identifier of the account the webhook belongs to.

Response

The 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"
}