POST
/
api
/
service
/
webhook-subscription
/
ping
JavaScript
import Ivy from '@getivy/node-sdk';

const client = new Ivy({
  apiKey: 'My API Key',
});

const response = await client.webhook.subscription.ping({ id: {} });

console.log(response.id);
{
  "id": "<any>",
  "success": true,
  "response": "<any>",
  "statusCode": 123,
  "date": "<any>"
}

Authorizations

X-Ivy-Api-Key
string
header
required

API key for authentication

Body

application/json
id
any
required

The unique identifier of the webhook subscription to ping

Response

200 - application/json

Returns the ping result with response details

id
any
required

The unique identifier of the webhook subscription

success
boolean
required

Whether the ping was successful

response
any
required

The response from the webhook endpoint

statusCode
number
required

The HTTP status code returned by the webhook endpoint

date
any
required

The timestamp when the ping was executed