Webhook API

API for webhook management

Get list of Webhook Subscriptions

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

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

Responses

200

OK

*/*

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/subscription/webhook

HTTPcURLJavaScriptPython

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-12-13T08:02:04.435Z",
      "enabled": true,
      "blockedByErrorCount": true,
      "errorCount": 1,
      "errorFirstDate": "2025-12-13T08:02:04.435Z",
      "errorLastDate": "2025-12-13T08:02:04.435Z"
    }
  ]
}

Delete Webhook

delete

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

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

Responses

200

OK

No content

400

Bad Request

*/*

500

Internal Server Error

*/*

delete

/api/v1/subscription/webhook

HTTPcURLJavaScriptPython

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

Create Webhook

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

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

Responses

200

OK

*/*

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/subscription/webhook/create

HTTPcURLJavaScriptPython

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-12-13T08:02:04.435Z",
  "enabled": true,
  "blockedByErrorCount": true,
  "errorCount": 1,
  "errorFirstDate": "2025-12-13T08:02:04.435Z",
  "errorLastDate": "2025-12-13T08:02:04.435Z"
}

Change Webhook

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

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

Responses

200

OK

*/*

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/subscription/webhook/change

HTTPcURLJavaScriptPython

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-12-13T08:02:04.435Z",
  "enabled": true,
  "blockedByErrorCount": true,
  "errorCount": 1,
  "errorFirstDate": "2025-12-13T08:02:04.435Z",
  "errorLastDate": "2025-12-13T08:02:04.435Z"
}

Regenerate Webhook Api keys

delete

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

Object with request data

timestampinteger · int64Required

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

Responses

200

OK

*/*

400

Bad Request

*/*

500

Internal Server Error

*/*

delete

/api/v1/subscription/webhook/api-keys/regenerate

HTTPcURLJavaScriptPython

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-12-13T08:02:04.435Z",
  "enabled": true,
  "blockedByErrorCount": true,
  "errorCount": 1,
  "errorFirstDate": "2025-12-13T08:02:04.435Z",
  "errorLastDate": "2025-12-13T08:02:04.435Z"
}