Test connection to the client server
POST /api/v1/hooks/ping tests the connection between Upchain’s webhook and the client server.
Note: * indicates mandatory fields.
Request schema
| Method | URL |
|---|---|
| POST | /api/v1/hooks/ping |
Request Header
| Field | Value Type | Description of values |
|---|---|---|
*notificationUrl |
String | The URL to which the webhook’s http response should go. |
hmacSecret |
String | Enables data encryption. |
Sending this request sets a Ping-Pong communication sequence in motion. If the Ping communication returns a 200-http response, this will trigger the Upchain webhook to send a Pong communication to the server specified in the notificationUrl field. The server specified in notificationUrl should then process the Pong request.