v1

latestOpenAPI 3.0.02026-07-266091181.5 KB

Test Webhook Delivery

This endpoint will send test data to your webhook endpoint so you may verify your integration

get/api/v1/webhook/test

Query parameters

destinationstring uri required

The webhook endpoint URL where the test data will be sent

version'webhook/v1' required

API version, currently webhook/v1

kind'News/v1' | 'Signals/v1' | 'Earnings/v1' | 'Ratings/v1' | 'Dividends/v1' | 'IPOs/v1' | 'Guidance/v1' | 'Splits/v1' | 'OptionActivity/v1' | 'Conference/v1' | 'Economics/v1' | 'Offerings/v1' | 'MA/v1' | 'Retail/v1' | 'FDA/v1' | 'WIIMs/v1' | 'SECInsiderTransaction/v1' | 'GovernmentTrade/v1' required

Identifies the message kind for the test payload

tokenstring

Specify token to have data transformed for production usage

Response

Success - Test webhook delivery was sent successfully

statusstring

Example response

{
  "status": "success"
}