Test hooks endpoint

Credentials

No credentials are documented for this endpoint.

Test endpoint to verify webhook connectivity. Returns OK status.

Parameters

This endpoint takes no path, query or header parameters.

Request body

Content type: application/json

Code samples

curl

curl -X POST 'https://sandbox.payme.io/api/partner/api/income-documents/hooks' \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

Node.js

const response = await fetch("https://sandbox.payme.io/api/partner/api/income-documents/hooks", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});

console.log(await response.text());

Python

import requests

response = requests.post(
    "https://sandbox.payme.io/api/partner/api/income-documents/hooks",
    json={},
)

print(response.text)

PHP

<?php

$body = <<<'BODY'
{}
BODY;

$ch = curl_init('https://sandbox.payme.io/api/partner/api/income-documents/hooks');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => $body,
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

Responses

200 — Webhook endpoint is active (success)

Field Type Description
status string