Webhook API
API for webhook management
Permission annotations:
Object with request data
Merchant account ID. Request will be sent for this account
Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future
POST /api/v1/subscription/webhook HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 32
{
"account": "text",
"timestamp": 1
}
{
"subscriptions": [
{
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"notificationEventTypes": [
"PAYOUT_CHANGE_STATUS"
],
"url": "text",
"publicKey": "text",
"secretKey": "text",
"createdDate": "2025-07-05T17:08:22.769Z"
}
]
}
Permission annotations:
Object with request data
Merchant account ID. Request will be sent for this account
Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future
DELETE /api/v1/subscription/webhook HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 95
{
"account": "text",
"timestamp": 1,
"payload": {
"requestId": "123e4567-e89b-12d3-a456-426614174000"
}
}
No content
Permission annotations:
Object with request data
Merchant account ID. Request will be sent for this account
Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future
POST /api/v1/subscription/webhook/create HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 196
{
"account": "text",
"timestamp": 1,
"payload": {
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"notificationEventTypes": [
"PAYOUT_CHANGE_STATUS"
],
"notificationServiceTypes": [
"PAYOUT"
],
"url": "text"
}
}
{
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"notificationEventTypes": [
"PAYOUT_CHANGE_STATUS"
],
"url": "text",
"publicKey": "text",
"secretKey": "text",
"createdDate": "2025-07-05T17:08:22.769Z"
}
Permission annotations:
Object with request data
Merchant account ID. Request will be sent for this account
Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future
POST /api/v1/subscription/webhook/change HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 196
{
"account": "text",
"timestamp": 1,
"payload": {
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"notificationEventTypes": [
"PAYOUT_CHANGE_STATUS"
],
"notificationServiceTypes": [
"PAYOUT"
],
"url": "text"
}
}
{
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"notificationEventTypes": [
"PAYOUT_CHANGE_STATUS"
],
"url": "text",
"publicKey": "text",
"secretKey": "text",
"createdDate": "2025-07-05T17:08:22.769Z"
}
Permission annotations:
Object with request data
Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future
DELETE /api/v1/subscription/webhook/api-keys/regenerate HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 78
{
"timestamp": 1,
"payload": {
"requestId": "123e4567-e89b-12d3-a456-426614174000"
}
}
{
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"notificationEventTypes": [
"PAYOUT_CHANGE_STATUS"
],
"url": "text",
"publicKey": "text",
"secretKey": "text",
"createdDate": "2025-07-05T17:08:22.769Z"
}