Send a test webhook

Send a test webhook to the configured endpoint

POST /sandbox/webhooks/test

cURL

cURL

curl --request POST \
  --url https://api.lightspark.com/grid/2025-10-13/sandbox/webhooks/test \
  --header 'Authorization: Basic <encoded-value>'

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 testWebhookResponse = await client.sandbox.webhooks.sendTest();

console.log(testWebhookResponse.response_status);

package com.lightspark.grid.example

import com.lightspark.grid.client.LightsparkGridClient
import com.lightspark.grid.client.okhttp.LightsparkGridOkHttpClient
import com.lightspark.grid.models.sandbox.webhooks.TestWebhookResponse
import com.lightspark.grid.models.sandbox.webhooks.WebhookSendTestParams

fun main() {
    val client: LightsparkGridClient = LightsparkGridOkHttpClient.fromEnv()

    val testWebhookResponse: TestWebhookResponse = client.sandbox().webhooks().sendTest()
}

200

{
  "response_status": 200,
  "url": "https://api.mycompany.com/webhooks/uma",
  "response_body": "<string>"
}

{
  "status": 400,
  "message": "<string>",
  "details": {}
}

{
  "status": 401,
  "message": "<string>",
  "details": {}
}

{
  "status": 500,
  "message": "<string>",
  "details": {}
}

Authorizations

Authorization · string · header · required

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

Response

200

application/json

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