Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.codex.io/llms.txt

Use this file to discover all available pages before exploring further.

​
name
String!
required
The name of the webhook (max 128 characters).
​
callbackUrl
String!
required
The url to which the webhook message should be sent.
​
securityToken
String!
required
A string value to hash along with deduplicationId using SHA-256. Included in the webhook message for added security.
​
alertRecurrence
AlertRecurrence!
required
The recurrence of the webhook. Can be INDEFINITE or ONCE. See AlertRecurrence
​
conditions
MarketCapEventWebhookConditionInput!
required
The conditions which must be met in order for the webhook to send a message. See MarketCapEventWebhookConditionInput
​
retrySettings
RetrySettingsInput
The settings for retrying failed webhook messages. See RetrySettingsInput
​
bucketKey
BucketKeyInput
An optional bucket key for grouping and querying webhooks. Prefer this over the deprecated flat bucket fields. See BucketKeyInput
​
publishingType
PublishingType
The type of publishing for the webhook. If not set, it defaults to SINGLE. See PublishingType
​
deduplicate
Boolean
If enabled, new webhooks won’t be created if a webhook with the same parameters already exists. If callbackUrl, conditions, publishingType, and alertRecurrence all match, then we return the existing webhook.
​
groupId
String
deprecated
A webhook group ID (max 64 characters). Can be used to group webhooks so that their messages are kept in order as a group rather than by individual webhook.
This field is deprecated. GroupId is deprecated and will be removed in the future. Messages will be grouped by webhookId
​
bucketId
String
deprecated
Deprecated. Use bucketKey.bucketId instead. Existing webhooks created with bucketId and bucketSortkey will continue to work.
This field is deprecated. Use bucketKey.bucketId instead.
​
bucketSortkey
String
deprecated
Deprecated. Use bucketKey.bucketSortKey instead. Existing webhooks created with bucketId and bucketSortkey will continue to work.
This field is deprecated. Use bucketKey.bucketSortKey instead.

​
Used By

Used as input by
  • createWebhooks: Create event webhooks for price, token/pair, transfer, market cap, and prediction market trades.