Webhooks

https://api.payload.com/webhooks

Nested Objects

https://api.payload.com/webhooks/{id}/logs

https://api.payload.com/webhooks/{id}/payment_link

Example

{
  "id": "18pX2dzyxW7DhS8JFJeG8nsNN",
  "object": "webhook",
  "attrs": {},
  "created_at": "2024-08-21 13:35:03",
  "modified_at": "2024-08-21 13:35:03",
  "payment_link_id": "pay_bdJlNFxE6UD63nrL2ImYaSIk",
  "reference_object": "string",
  "trigger": "bank_account_reject",
  "url": "https://example.com/bank_account_reject",
  "oauth_params": {
    "auth_url": "string",
    "client_id": "string",
    "client_secret": "string",
    "grant_type": "string",
    "resource": "string",
    "scope": "string"
  }
}

Attributes	Description
`id` string readonly	Object ID
`object` string readonly	Value: webhook
`attrs` json	Custom object attributes
`created_at` datetime readonly	None
`modified_at` datetime readonly	None
`payment_link_id` id	ID of object reference
`reference_object` string non-default	Type of object reference
`trigger` string required	Values: bank_account_reject reject refund void chargeback chargeback_reversal automatic_payment payment processed authorized decline processing_status deposit payment_activation:status payment_link:status reversal credit transaction:operation transaction:operation:clear
`url` string required	Triggered URL

oauth_params:
`auth_url` string required	The url of the OAuth 2.0 token request
`client_id` string required	The client identifier of the OAuth 2.0 client
`client_secret` string required	The client secret of the OAuth 2.0 client
`grant_type` string required	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