Skip to main content
GET
List webhooks

Authorizations

Authorization
string
header
required

JWT obtained from /v2/auth/login

Response

Configured webhooks.

id
string
required

Unique webhook identifier.

Example:

"550e8400-e29b-41d4-a716-446655440000"

callbalckUrl
string
required

URL configured to receive notifications.

Example:

"https://partner.example.com/webhooks/yp"

events
object
required

Configured events.

createdAt
string
required

Creation date.

Example:

"2026-05-12T12:00:00.000Z"

updatedAt
string
required

Last update date.

Example:

"2026-05-12T12:00:00.000Z"

status
enum<string>
required

Webhook status.

Available options:
ACTIVE,
INACTIVE,
SUSPENDED
Example:

"ACTIVE"

description
object | null

Webhook description.

Example:

"Primary webhook"