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.
Input for creating token pair event webhooks.
See CreateTokenPairEventWebhooksInput
Show Properties
Show Properties
A list of token pair event webhooks to create.
See CreateTokenPairEventWebhookArgs
Show Properties
Show Properties
The name of the webhook (max 128 characters).
The url to which the webhook message should be sent.
A string value to hash along with
deduplicationId using SHA-256. Included in the webhook message for added security.The recurrence of the webhook. Can be
INDEFINITE or ONCE.
See AlertRecurrenceThe conditions which must be met in order for the webhook to send a message.
See TokenPairEventWebhookConditionInput
Show Properties
Show Properties
A list of network IDs to listen on.
See OneOfNumberConditionInput
Show Properties
Show Properties
The list of integers.
The maker wallet address to listen for.
See StringEqualsConditionInput
Show Properties
Show Properties
The string to equal.
The pair contract address to listen for.
See StringEqualsConditionInput
Show Properties
Show Properties
The string to equal.
The exchange contract address to listen for.
See StringEqualsConditionInput
Show Properties
Show Properties
The string to equal.
The token contract address to listen for.
See StringEqualsConditionInput
Show Properties
Show Properties
The string to equal.
The settings for retrying failed webhook messages.
See RetrySettingsInput
Show Properties
Show Properties
The maximum time in seconds that the webhook will retry sending a message
The minimum time in seconds that the webhook will wait before retrying a failed message
The maximum time in seconds that the webhook will wait before retrying a failed message
The maximum number of times the webhook will retry sending a message
An optional bucket key for grouping and querying webhooks. Prefer this over the deprecated flat bucket fields.
See BucketKeyInput
The type of publishing for the webhook. If not set, it defaults to
SINGLE.
See PublishingTypeIf 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.
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
Deprecated. Use
bucketKey.bucketId instead. Existing webhooks created with bucketId and bucketSortkey will continue to work.This field is deprecated. Use bucketKey.bucketId instead.
Deprecated. Use
bucketKey.bucketSortKey instead. Existing webhooks created with bucketId and bucketSortkey will continue to work.This field is deprecated. Use bucketKey.bucketSortKey instead.
Input for creating raw transaction webhooks.
See CreateRawTransactionWebhooksInput
Show Properties
Show Properties
A list of Raw Transaction webhooks to create.
See CreateRawTransactionWebhookArgs
Show Properties
Show Properties
The name of the webhook (max 128 characters).
The url to which the webhook message should be sent.
A string value to hash along with
deduplicationId using SHA-256. Included in the webhook message for added security.The recurrence of the webhook. Can be
INDEFINITE or ONCE.
See AlertRecurrenceThe conditions which must be met in order for the webhook to send a message.
See RawTransactionWebhookConditionInput
Show Properties
Show Properties
A list of network IDs to listen on.
See OneOfNumberConditionInput
Show Properties
Show Properties
The list of integers.
The to address to listen for.
See StringEqualsConditionInput
Show Properties
Show Properties
The string to equal.
The from address to listen for.
See StringEqualsConditionInput
Show Properties
Show Properties
The string to equal.
Trigger the webhook if either the to or the from address matches.
See StringEqualsConditionInput
Show Properties
Show Properties
The string to equal.
Trigger the webhook if the input contains or doesn’t contain the specified string.
See StringContainsConditionInput
Do not trigger the webhook if the raw transaction is handled by the TokenPairEvent webhook.
The settings for retrying failed webhook messages.
See RetrySettingsInput
Show Properties
Show Properties
The maximum time in seconds that the webhook will retry sending a message
The minimum time in seconds that the webhook will wait before retrying a failed message
The maximum time in seconds that the webhook will wait before retrying a failed message
The maximum number of times the webhook will retry sending a message
An optional bucket key for grouping and querying webhooks. Prefer this over the deprecated flat bucket fields.
See BucketKeyInput
The type of publishing for the webhook. If not set, it defaults to
SINGLE.
See PublishingTypeIf 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.
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
Deprecated. Use
bucketKey.bucketId instead. Existing webhooks created with bucketId and bucketSortkey will continue to work.This field is deprecated. Use bucketKey.bucketId instead.
Deprecated. Use
bucketKey.bucketSortKey instead. Existing webhooks created with bucketId and bucketSortkey will continue to work.This field is deprecated. Use bucketKey.bucketSortKey instead.
Input for creating market cap webhooks.
See CreateMarketCapWebhooksInput
Show Properties
Show Properties
A list of market cap webhooks to create.
See CreateMarketCapWebhookArgs
Show Properties
Show Properties
The name of the webhook (max 128 characters).
The url to which the webhook message should be sent.
A string value to hash along with
deduplicationId using SHA-256. Included in the webhook message for added security.The recurrence of the webhook. Can be
INDEFINITE or ONCE.
See AlertRecurrenceThe conditions which must be met in order for the webhook to send a message.
See MarketCapEventWebhookConditionInput
Show Properties
Show Properties
The contract address of the token to listen for.
See StringEqualsConditionInput
Show Properties
Show Properties
The string to equal.
The network ID to listen on.
See IntEqualsConditionInput
Show Properties
Show Properties
The integer to equal.
The contract address of the pair to listen for.
See StringEqualsConditionInput
Show Properties
Show Properties
The string to equal.
The settings for retrying failed webhook messages.
See RetrySettingsInput
Show Properties
Show Properties
The maximum time in seconds that the webhook will retry sending a message
The minimum time in seconds that the webhook will wait before retrying a failed message
The maximum time in seconds that the webhook will wait before retrying a failed message
The maximum number of times the webhook will retry sending a message
An optional bucket key for grouping and querying webhooks. Prefer this over the deprecated flat bucket fields.
See BucketKeyInput
The type of publishing for the webhook. If not set, it defaults to
SINGLE.
See PublishingTypeIf 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.
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
Deprecated. Use
bucketKey.bucketId instead. Existing webhooks created with bucketId and bucketSortkey will continue to work.This field is deprecated. Use bucketKey.bucketId instead.
Deprecated. Use
bucketKey.bucketSortKey instead. Existing webhooks created with bucketId and bucketSortkey will continue to work.This field is deprecated. Use bucketKey.bucketSortKey instead.
Input for creating token price event webhooks.
See CreateTokenPriceEventWebhooksInput
Show Properties
Show Properties
A list of token price event webhooks to create.
See CreateTokenPriceEventWebhookArgs
Show Properties
Show Properties
The name of the webhook (max 128 characters).
The url to which the webhook message should be sent.
A string value to hash along with
deduplicationId using SHA-256. Included in the webhook message for added security.The recurrence of the webhook. Can be
INDEFINITE or ONCE.
See AlertRecurrenceThe conditions which must be met in order for the webhook to send a message.
See TokenPriceEventWebhookConditionInput
Show Properties
Show Properties
The contract address of the token to listen for.
See StringEqualsConditionInput
Show Properties
Show Properties
The string to equal.
The network ID to listen on.
See IntEqualsConditionInput
Show Properties
Show Properties
The integer to equal.
The settings for retrying failed webhook messages.
See RetrySettingsInput
Show Properties
Show Properties
The maximum time in seconds that the webhook will retry sending a message
The minimum time in seconds that the webhook will wait before retrying a failed message
The maximum time in seconds that the webhook will wait before retrying a failed message
The maximum number of times the webhook will retry sending a message
An optional bucket key for grouping and querying webhooks. Prefer this over the deprecated flat bucket fields.
See BucketKeyInput
The type of publishing for the webhook. If not set, it defaults to
SINGLE.
See PublishingTypeIf 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.
Deprecated. Use
bucketKey.bucketId instead. Existing webhooks created with bucketId and bucketSortkey will continue to work.This field is deprecated. Use bucketKey.bucketId instead.
Deprecated. Use
bucketKey.bucketSortKey instead. Existing webhooks created with bucketId and bucketSortkey will continue to work.This field is deprecated. Use bucketKey.bucketSortKey instead.
Input for creating token transfer event webhooks.
See CreateTokenTransferEventWebhooksInput
Show Properties
Show Properties
A list of token transfer event webhooks to create.
See CreateTokenTransferEventWebhookArgs
Show Properties
Show Properties
The name of the webhook (max 128 characters).
The url to which the webhook message should be sent.
A string value to hash along with
deduplicationId using SHA-256. Included in the webhook message for added security.The recurrence of the webhook. Can be
INDEFINITE or ONCE.
See AlertRecurrenceThe conditions which must be met in order for the webhook to send a message.
See TokenTransferEventWebhookConditionInput
Show Properties
Show Properties
The contract address of the token to listen for.
See StringEqualsConditionInput
Show Properties
Show Properties
The string to equal.
The list of network IDs to listen on.
See OneOfNumberConditionInput
Show Properties
Show Properties
The list of integers.
The wallet address to listen for transfers from or to.
See StringEqualsConditionInput
Show Properties
Show Properties
The string to equal.
The direction of the transfer (TO, FROM). Defaults to [TO, FROM] if not specified.
See OneOfTokenTransferDirectionConditionInput
Show Properties
Show Properties
The list of transfer directions to listen for.
See TokenTransferDirection
The settings for retrying failed webhook messages.
See RetrySettingsInput
Show Properties
Show Properties
The maximum time in seconds that the webhook will retry sending a message
The minimum time in seconds that the webhook will wait before retrying a failed message
The maximum time in seconds that the webhook will wait before retrying a failed message
The maximum number of times the webhook will retry sending a message
An optional bucket key for grouping and querying webhooks. Prefer this over the deprecated flat bucket fields.
See BucketKeyInput
The type of publishing for the webhook. If not set, it defaults to
SINGLE.
See PublishingTypeIf 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.
Deprecated. Use
bucketKey.bucketId instead. Existing webhofoks created with bucketId and bucketSortkey will continue to work.This field is deprecated. Use bucketKey.bucketId instead.
Deprecated. Use
bucketKey.bucketSortKey instead. Existing webhooks created with bucketId and bucketSortkey will continue to work.This field is deprecated. Use bucketKey.bucketSortKey instead.
Input for creating prediction trade webhooks.
See CreatePredictionTradeWebhooksInput
Show Properties
Show Properties
A list of prediction trade webhooks to create.
See CreatePredictionTradeWebhookArgs
Show Properties
Show Properties
The name of the webhook (max 128 characters).
The url to which the webhook message should be sent.
A string value to hash along with
deduplicationId using SHA-256. Included in the webhook message for added security.The recurrence of the webhook. Can be
INDEFINITE or ONCE.
See AlertRecurrenceThe conditions which must be met in order for the webhook to send a message.
See PredictionTradeWebhookConditionInput
Show Properties
Show Properties
The trader ID to listen for.
See StringEqualsConditionInput
Show Properties
Show Properties
The string to equal.
The market ID to listen for.
See StringEqualsConditionInput
Show Properties
Show Properties
The string to equal.
The event ID to listen for.
See StringEqualsConditionInput
Show Properties
Show Properties
The string to equal.
The trade event types to listen for.
See PredictionTradeEventTypeConditionInput
The settings for retrying failed webhook messages.
See RetrySettingsInput
Show Properties
Show Properties
The maximum time in seconds that the webhook will retry sending a message
The minimum time in seconds that the webhook will wait before retrying a failed message
The maximum time in seconds that the webhook will wait before retrying a failed message
The maximum number of times the webhook will retry sending a message
An optional bucket key for grouping and querying webhooks. Prefer this over the deprecated flat bucket fields.
See BucketKeyInput
Input for creating prediction market metrics event webhooks.
See CreatePredictionMarketMetricsEventWebhooksInput
Show Properties
Show Properties
A list of prediction market metrics event webhooks to create.
See CreatePredictionMarketMetricsEventWebhookArgs
Show Properties
Show Properties
The name of the webhook (max 128 characters).
The url to which the webhook message should be sent.
A string value to hash along with
deduplicationId using SHA-256. Included in the webhook message for added security.The recurrence of the webhook. Can be
INDEFINITE or ONCE.
See AlertRecurrenceThe conditions which must be met in order for the webhook to send a message.
See PredictionMarketMetricsEventWebhookConditionInput
Show Properties
Show Properties
The market ID to listen for.
See StringEqualsConditionInput
Show Properties
Show Properties
The string to equal.
Conditions evaluated against market-level aggregate stats. ANDed with other clauses when also present.
See PredictionMarketMetricsEventMarketConditionInput
Show Properties
Show Properties
See WindowedPredictionMarketMetricsEventMarketConditionInput
Show Properties
Show Properties
See WindowedPredictionMarketMetricsEventMarketConditionInput
Show Properties
Show Properties
See WindowedPredictionMarketMetricsEventMarketConditionInput
Show Properties
Show Properties
See WindowedPredictionMarketMetricsEventMarketConditionInput
Show Properties
Show Properties
See WindowedPredictionMarketMetricsEventMarketConditionInput
Show Properties
Show Properties
See WindowedPredictionMarketMetricsEventMarketConditionInput
Show Properties
Show Properties
Conditions evaluated against outcome 0’s stats. ANDed with outcome1 and anyOutcome when also present.
See PredictionMarketMetricsEventOutcomeConditionInput
Show Properties
Show Properties
Conditions for the 5-minute window.
See WindowedPredictionMarketMetricsEventOutcomeConditionInput
Show Properties
Show Properties
Conditions for the 1-hour window.
See WindowedPredictionMarketMetricsEventOutcomeConditionInput
Show Properties
Show Properties
Conditions for the 4-hour window.
See WindowedPredictionMarketMetricsEventOutcomeConditionInput
Show Properties
Show Properties
Conditions for the 12-hour window.
See WindowedPredictionMarketMetricsEventOutcomeConditionInput
Show Properties
Show Properties
Conditions for the 1-day window.
See WindowedPredictionMarketMetricsEventOutcomeConditionInput
Show Properties
Show Properties
Conditions for the 1-week window.
See WindowedPredictionMarketMetricsEventOutcomeConditionInput
Show Properties
Show Properties
Conditions evaluated against outcome 1’s stats. ANDed with outcome0 and anyOutcome when also present.
See PredictionMarketMetricsEventOutcomeConditionInput
Show Properties
Show Properties
Conditions for the 5-minute window.
See WindowedPredictionMarketMetricsEventOutcomeConditionInput
Show Properties
Show Properties
Conditions for the 1-hour window.
See WindowedPredictionMarketMetricsEventOutcomeConditionInput
Show Properties
Show Properties
Conditions for the 4-hour window.
See WindowedPredictionMarketMetricsEventOutcomeConditionInput
Show Properties
Show Properties
Conditions for the 12-hour window.
See WindowedPredictionMarketMetricsEventOutcomeConditionInput
Show Properties
Show Properties
Conditions for the 1-day window.
See WindowedPredictionMarketMetricsEventOutcomeConditionInput
Show Properties
Show Properties
Conditions for the 1-week window.
See WindowedPredictionMarketMetricsEventOutcomeConditionInput
Show Properties
Show Properties
Conditions evaluated against both outcomes; matches if at least one outcome satisfies. ANDed with outcome0 and outcome1 when also present.
See PredictionMarketMetricsEventOutcomeConditionInput
Show Properties
Show Properties
Conditions for the 5-minute window.
See WindowedPredictionMarketMetricsEventOutcomeConditionInput
Show Properties
Show Properties
Conditions for the 1-hour window.
See WindowedPredictionMarketMetricsEventOutcomeConditionInput
Show Properties
Show Properties
Conditions for the 4-hour window.
See WindowedPredictionMarketMetricsEventOutcomeConditionInput
Show Properties
Show Properties
Conditions for the 12-hour window.
See WindowedPredictionMarketMetricsEventOutcomeConditionInput
Show Properties
Show Properties
Conditions for the 1-day window.
See WindowedPredictionMarketMetricsEventOutcomeConditionInput
Show Properties
Show Properties
Conditions for the 1-week window.
See WindowedPredictionMarketMetricsEventOutcomeConditionInput
Show Properties
Show Properties
The settings for retrying failed webhook messages.
See RetrySettingsInput
Show Properties
Show Properties
The maximum time in seconds that the webhook will retry sending a message
The minimum time in seconds that the webhook will wait before retrying a failed message
The maximum time in seconds that the webhook will wait before retrying a failed message
The maximum number of times the webhook will retry sending a message
An optional bucket key for grouping and querying webhooks. Prefer this over the deprecated flat bucket fields.
See BucketKeyInput
The type of publishing for the webhook. If not set, it defaults to
SINGLE.
See PublishingTypeIf 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.
Input for creating price webhooks.
See CreatePriceWebhooksInput
This field is deprecated. Use tokenPriceEventWebhooksInput instead.
Show Properties
Show Properties
A list of price webhooks to create.
See CreatePriceWebhookArgs
Show Properties
Show Properties
The name of the webhook (max 128 characters).
The url to which the webhook message should be sent.
A string value to hash along with
deduplicationId using SHA-256. Included in the webhook message for added security.The recurrence of the webhook. Can be
INDEFINITE or ONCE.
See AlertRecurrenceThe conditions which must be met in order for the webhook to send a message.
See PriceEventWebhookConditionInput
Show Properties
Show Properties
The contract address of the token to listen for.
See StringEqualsConditionInput
Show Properties
Show Properties
The string to equal.
The network ID to listen on.
See IntEqualsConditionInput
Show Properties
Show Properties
The integer to equal.
The contract address of the pair to listen for.
See StringEqualsConditionInput
Show Properties
Show Properties
The string to equal.
The settings for retrying failed webhook messages.
See RetrySettingsInput
Show Properties
Show Properties
The maximum time in seconds that the webhook will retry sending a message
The minimum time in seconds that the webhook will wait before retrying a failed message
The maximum time in seconds that the webhook will wait before retrying a failed message
The maximum number of times the webhook will retry sending a message
An optional bucket key for grouping and querying webhooks. Prefer this over the deprecated flat bucket fields.
See BucketKeyInput
The type of publishing for the webhook. If not set, it defaults to
SINGLE.
See PublishingTypeIf 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.
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
Deprecated. Use
bucketKey.bucketId instead. Existing webhooks created with bucketId and bucketSortkey will continue to work.This field is deprecated. Use bucketKey.bucketId instead.
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.