Skip to main content
POST
Create webhook

Authorizations

Authorization
string
header
required

JWT obtained from /v2/auth/login

Body

application/json

Webhook data to create.

url
string
required

Partner HTTPS URL where YP sends notifications.

Example:

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

events
object
required

Subscribed events.

description
string

Internal webhook description.

Maximum string length: 255
Example:

"Primary webhook"

apiKey
string

Optional API key associated with the webhook.

Example:

"partner-secret"

status
enum<string>
default:ACTIVE

Webhook status.

Available options:
ACTIVE,
INACTIVE,
SUSPENDED
Example:

"ACTIVE"

Response

Webhook created successfully.

id
string
required

Unique webhook identifier.

Example:

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

url
string
required

URL configured to receive notifications.

Example:

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

events
enum<string>[]
required

Configured events.

Available options:
pending_transaction,
processing_transaction,
completed_transaction,
reject_transaction,
failed_transaction,
expired_transaction
Example:
apiKey
object | null

API key associated with the webhook, if present.

Example:

null

description
object | null

Webhook description.

Example:

"Primary webhook"