POST /v1/webhooks

#POST /v1/webhookscreateWebhook

Add an endpoint; the signing secret is shown once

Parameters

Answer

data: { endpoint, secret }

Body (JSON)

{ url, events: [calendar.release | calendar.revised | alert.fired], description?, filter? }

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

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

from chartdeck import Client

client = Client()  # reads CHARTDECK_API_KEY
r = client.webhooks.create(body={...})
print(r.data, r.meta["attribution"])

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

const cd = new ChartDeck();  // reads CHARTDECK_API_KEY
const r = await cd.webhooks.create({ ... });
console.log(r.data, r.meta.attribution);