https://api.payload.co/webhooks
Nested Objects
https://api.payload.co/webhooks/{id}/logs
https://api.payload.co/webhooks/{id}/payment_link
Example
{
"id": "1EQNvpiivsXRvCumYoWRQBSTp",
"object": "webhook",
"attrs": {},
"created_at": "2022-02-02 21:11:49",
"modified_at": "2022-02-02 21:11:49",
"payment_link_id": "pay_iRvVp7ApwYON0AD1uSwaDDIr",
"reference_object": "string",
"trigger": "reject",
"url": "https://example.com/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 |
Timestamp object was created |
modified_at datetime readonly |
Timestamp object was last updated |
payment_link_id id |
ID of object reference |
reference_object string non-default |
Type of object reference |
trigger string required |
Values: reject refund void reversal automatic_payment payment processed authorized credit decline processing_status deposit payment_activation:status payment_link:status |
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 |