POST /v1/webhooks/{id}/test

#`POST /v1/webhooks/{id}/test`testWebhook

Send a signed test event (ping) to the endpoint now

Scope	webhooks:write
Lowest tier	developer
Weight (units)	1
SDK	Python client.webhooks.test · JavaScript cd.webhooks.test

Parameters

Parameter	In	Type	Description
`id` required	path	`string`	Endpoint id.
`Idempotency-Key`	header	`string`	Any unique string; a retried write with the same key acts once.

Answer

data: { event_id }

Errors

400 invalid_param, invalid_cursor
401 unauthorized: missing, unknown, revoked or expired key
403 insufficient_scope, tier_required
404 not_found, not_available, not_in_sandbox
422 window_too_large
429 rate_limited (per minute) or quota_exhausted (month; X-Quota-* headers, Retry-After = seconds to the next month); see Retry-After
503 api_disabled, overloaded

Example

Shell

curl -X POST "https://api.chartdeck.trade/v1/webhooks/<id>/test" \
  -H "Authorization: Bearer $CHARTDECK_API_KEY"

Python

from chartdeck import Client

client = Client()  # reads CHARTDECK_API_KEY
r = client.webhooks.test("<id>")
print(r.data, r.meta["attribution"])

JavaScript

import { ChartDeck } from '@chartdeck/api';

const cd = new ChartDeck();  // reads CHARTDECK_API_KEY
const r = await cd.webhooks.test("<id>");
console.log(r.data, r.meta.attribution);

POST /v1/webhooks/{id}/test

#POST /v1/webhooks/{id}/testtestWebhook

#`POST /v1/webhooks/{id}/test`testWebhook