Webhook Schema

Real-time event notifications via HTTP requests to specified URLs

The Webhook schema defines the structure and properties of webhook objects in the Payload API. Webhooks enable real-time notifications by triggering HTTP requests to specified URLs when certain events occur in the system.

Webhook Object Properties

Complete reference for all properties available in the Webhook schema

attrs

object

Custom attributes for extending the resource with additional key-value pairs. Maximum length is 255 characters when serialized.

created_at

string (date-time)Read-only

Timestamp when the resource was created. Automatically set by the system and immutable.

id

stringRead-only

Unique identifier for the resource. Automatically generated upon creation and cannot be modified. (ID prefix: None)

Pattern: ^None_[A-Za-z0-9]+$

modified_at

string (date-time)Read-only

Timestamp when the resource was last modified. Automatically updated whenever any field changes.

oauth_params

object

OAuth Parameters

auth_url

string

The url of the OAuth 2.0 token request

client_id

string

The client identifier of the OAuth 2.0 client

client_secret

string

The client secret of the OAuth 2.0 client

grant_type

string

Indicates that a token exchange is being performed

resource

string

Indicates the location of the target service or resource

scope

string

Optional parameter to limit access to a user's account

object

enum[string]Read-only

String representing the object type for this resource.

Values: webhook

payment_link_id ID of PaymentLink

string

ID of object reference (ID prefix: None)

Pattern: ^None_[A-Za-z0-9]+$

retries

integer (int64)

Number of times to retry a webhook on failure

sender_secret

string

Secret key for HMAC-SHA256 signature verification. When set, webhook requests will include an X-Payload-Signature header. This field is write-only and will not be returned in responses.

Max length: 64

trigger

enum[string]Required

No description

Values:

bank_account_reject, reject, refund, void, chargeback, chargeback_reversal, automatic_payment, payment, processed, authorized, adjusted, decline, processing_status, deposit, payment_activation:status, payment_link:status, reversal, credit, transaction:operation, transaction:operation:clear, payout, withdraw

url

stringRequired

Triggered URL

Max length: 512

Intent WebhookLog