Get webhook (extended)

The method allows you to get full information about the webhook.

Get webhook (extended)

post

/api-gateway/webhooks/get-verbose

Header parameters

x-api-public-keystring

Public API-key

x-api-signaturestring

Signing the request body with a private API-key

Content-typestring

Request content type

Example: application/json

Body

webhookIdstringrequired

Webhook ID

Example: 8d7db145-80cc-4c43-9cfb-9cde10f8ef40

fieldsstring · enum[]

Get only necessary fields in response from provided filter (array of names)

Example: ["id","event","requestBody"]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://ocp.onchainpay.io/api-gateway/webhooks/get-verbose' \
  --header 'Content-Type: application/json' \
  --data '{"webhookId":"8d7db145-80cc-4c43-9cfb-9cde10f8ef40","fields":["id","event","requestBody"]}'

200

200

{
  "success": true,
  "response": {
    "id": "8d7db145-80cc-4c43-9cfb-9cde10f8ef40",
    "eventId": "bf9aae10-3c13-4566-afab-8f38a29200da",
    "requestUrl": "https://site.com/webhook",
    "requestBody": "{\"id\":\"6ef4d153-0104-46c6-b207-30835b485ee3\",\"advancedBalanceId\":\"316a59ea-be39-4eaa-9392-6fda708f24d8\",...",
    "responseCode": 1,
    "responseBody": "ok",
    "sentAt": "2023-10-30T10:36:10.121Z",
    "signature": "0ae0fdaef0547f9c8262f768a024934b0e730d4ebfaf611c14d75b0c090cce8e",
    "apiKey": "eb5wFqcOxkfm9VSqKqZ/XXxJQEQNPbzYFM6IrJIkNG88uKwao9BKDfgKTbvoNHBgXpwaCXYCW8SXYTjuVm7W0w==",
    "apiKeyAlias": "Test api key",
    "createdAt": "2023-10-16T14:30:18.676Z",
    "updatedAt": "2023-10-30T10:36:10.559Z",
    "event": "DEPOSIT_PERSONAL",
    "responseStatus": "SUCCESS",
    "requestHeaders": {
      "Content-Type": "application/json"
    }
  }
}