Skip to main content
POST
/
webhooks
/
test
JavaScript
import LightsparkGrid from '@lightsparkdev/grid';

const client = new LightsparkGrid({
  username: process.env['GRID_CLIENT_ID'], // This is the default and can be omitted
  password: process.env['GRID_CLIENT_SECRET'], // This is the default and can be omitted
});

const response = await client.sandbox.sendTestWebhook();

console.log(response.response_status);
{
  "response_status": 200,
  "url": "https://api.mycompany.com/webhooks/uma",
  "response_body": "<string>"
}

Authorizations

​
Authorization
string
header
required

API token authentication using format <api token id>:<api client secret>

Response

Webhook delivered successfully

​
response_status
integer
required

The HTTP status code returned by the webhook endpoint

Example:

200

​
url
string<uri>

URL where the webhook was sent

Example:

"https://api.mycompany.com/webhooks/uma"

​
response_body
string

The raw body content returned by the webhook endpoint in response to the request