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.
This endpoint requires a Growth or Enterprise plan. Learn more.
Returns
See GetWebhooksResponse
Show Properties
Show Properties
A list of webhooks belonging to a user.
See Webhook
Show Properties
Show Properties
The ID of the webhook.
The given name of the webhook.
The unix timestamp for the time the webhook was created.
The recurrence of the webhook. Can be
INDEFINITE or ONCE.
See AlertRecurrenceThe url to which the webhook message should be sent.
The status of the webhook. Can be
ACTIVE or INACTIVE.The conditions which must be met in order for the webhook to send a message.
See WebhookCondition
Show Properties
Show Properties
See PriceEventWebhookCondition
Show Properties
Show Properties
The token contract address the webhook is listening for.
See StringEqualsCondition
Show Properties
Show Properties
The string to equal.
The network ID the webhook is listening on.
See IntEqualsCondition
Show Properties
Show Properties
The integer to equal.
The pair contract address the webhook is listening for.
See StringEqualsCondition
Show Properties
Show Properties
The string to equal.
See MarketCapEventWebhookCondition
Show Properties
Show Properties
The token contract address the webhook is listening for.
See StringEqualsCondition
Show Properties
Show Properties
The string to equal.
The network ID the webhook is listening on.
See IntEqualsCondition
Show Properties
Show Properties
The integer to equal.
The pair contract address the webhook is listening for.
See StringEqualsCondition
Show Properties
Show Properties
The string to equal.
See TokenPairEventWebhookCondition
Show Properties
Show Properties
The token contract address the webhook is listening for.
See StringEqualsCondition
Show Properties
Show Properties
The string to equal.
The list of network IDs the webhook is listening on.
See OneOfNumberCondition
Show Properties
Show Properties
The list of integers.
The maker wallet address the webhook is listening for.
See StringEqualsCondition
Show Properties
Show Properties
The string to equal.
The pair contract address the webhook is listening for.
See StringEqualsCondition
Show Properties
Show Properties
The string to equal.
The exchange contract address the webhook is listening for.
See StringEqualsCondition
Show Properties
Show Properties
The string to equal.
See RawTransactionWebhookCondition
Show Properties
Show Properties
A list of network IDs to listen on.
See OneOfNumberCondition
Show Properties
Show Properties
The list of integers.
The to address to listen for.
See StringEqualsCondition
Show Properties
Show Properties
The string to equal.
The from address to listen for.
See StringEqualsCondition
Show Properties
Show Properties
The string to equal.
Trigger the webhook if either the to or the from address matches.
See StringEqualsCondition
Show Properties
Show Properties
The string to equal.
Trigger the webhook if the contains or doesn’t contain the specified string.
See StringContainsCondition
Do not trigger the webhook if the raw transaction is handled by the TokenPairEvent webhook.
See TokenPriceEventWebhookCondition
Show Properties
Show Properties
The token contract address the webhook is listening for.
See StringEqualsCondition
Show Properties
Show Properties
The string to equal.
The network ID the webhook is listening on.
See IntEqualsCondition
Show Properties
Show Properties
The integer to equal.
See TokenTransferEventWebhookCondition
Show Properties
Show Properties
The token contract address the webhook is listening for.
See StringEqualsCondition
Show Properties
Show Properties
The string to equal.
The list of network IDs the webhook is listening on.
See OneOfNumberCondition
Show Properties
Show Properties
The list of integers.
The wallet address the webhook is listening for transfers from or to.
See StringEqualsCondition
Show Properties
Show Properties
The string to equal.
The directions of the transfer the webhook is listening for.
See OneOfTokenTransferDirectionCondition
Show Properties
Show Properties
The list of transfer directions.
See TokenTransferDirection
See PredictionTradeWebhookCondition
Show Properties
Show Properties
The trader ID the webhook is listening for.
See StringEqualsCondition
Show Properties
Show Properties
The string to equal.
The market ID the webhook is listening for.
See StringEqualsCondition
Show Properties
Show Properties
The string to equal.
The event ID the webhook is listening for.
See StringEqualsCondition
Show Properties
Show Properties
The string to equal.
The trade event types the webhook is listening for.
See PredictionTradeEventTypeCondition
See PredictionMarketMetricsEventWebhookCondition
Show Properties
Show Properties
The market ID the webhook is listening for.
See StringEqualsCondition
Show Properties
Show Properties
The string to equal.
Conditions evaluated against market-level aggregate stats. ANDed with other clauses when also present.
See PredictionMarketMetricsEventMarketCondition
Show Properties
Show Properties
Conditions for the 5-minute window.
See WindowedPredictionMarketMetricsEventMarketCondition
Show Properties
Show Properties
Conditions for the 1-hour window.
See WindowedPredictionMarketMetricsEventMarketCondition
Show Properties
Show Properties
Conditions for the 4-hour window.
See WindowedPredictionMarketMetricsEventMarketCondition
Show Properties
Show Properties
Conditions for the 12-hour window.
See WindowedPredictionMarketMetricsEventMarketCondition
Show Properties
Show Properties
Conditions for the 1-day window.
See WindowedPredictionMarketMetricsEventMarketCondition
Show Properties
Show Properties
Conditions for the 1-week window.
See WindowedPredictionMarketMetricsEventMarketCondition
Show Properties
Show Properties
Conditions evaluated against outcome 0’s stats. ANDed with outcome1 and anyOutcome when also present.
See PredictionMarketMetricsEventOutcomeCondition
Show Properties
Show Properties
Conditions for the 5-minute window.
See WindowedPredictionMarketMetricsEventOutcomeCondition
Show Properties
Show Properties
Conditions for the 1-hour window.
See WindowedPredictionMarketMetricsEventOutcomeCondition
Show Properties
Show Properties
Conditions for the 4-hour window.
See WindowedPredictionMarketMetricsEventOutcomeCondition
Show Properties
Show Properties
Conditions for the 12-hour window.
See WindowedPredictionMarketMetricsEventOutcomeCondition
Show Properties
Show Properties
Conditions for the 1-day window.
See WindowedPredictionMarketMetricsEventOutcomeCondition
Show Properties
Show Properties
Conditions for the 1-week window.
See WindowedPredictionMarketMetricsEventOutcomeCondition
Show Properties
Show Properties
Conditions evaluated against outcome 1’s stats. ANDed with outcome0 and anyOutcome when also present.
See PredictionMarketMetricsEventOutcomeCondition
Show Properties
Show Properties
Conditions for the 5-minute window.
See WindowedPredictionMarketMetricsEventOutcomeCondition
Show Properties
Show Properties
Conditions for the 1-hour window.
See WindowedPredictionMarketMetricsEventOutcomeCondition
Show Properties
Show Properties
Conditions for the 4-hour window.
See WindowedPredictionMarketMetricsEventOutcomeCondition
Show Properties
Show Properties
Conditions for the 12-hour window.
See WindowedPredictionMarketMetricsEventOutcomeCondition
Show Properties
Show Properties
Conditions for the 1-day window.
See WindowedPredictionMarketMetricsEventOutcomeCondition
Show Properties
Show Properties
Conditions for the 1-week window.
See WindowedPredictionMarketMetricsEventOutcomeCondition
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 PredictionMarketMetricsEventOutcomeCondition
Show Properties
Show Properties
Conditions for the 5-minute window.
See WindowedPredictionMarketMetricsEventOutcomeCondition
Show Properties
Show Properties
Conditions for the 1-hour window.
See WindowedPredictionMarketMetricsEventOutcomeCondition
Show Properties
Show Properties
Conditions for the 4-hour window.
See WindowedPredictionMarketMetricsEventOutcomeCondition
Show Properties
Show Properties
Conditions for the 12-hour window.
See WindowedPredictionMarketMetricsEventOutcomeCondition
Show Properties
Show Properties
Conditions for the 1-day window.
See WindowedPredictionMarketMetricsEventOutcomeCondition
Show Properties
Show Properties
Conditions for the 1-week window.
See WindowedPredictionMarketMetricsEventOutcomeCondition
Show Properties
Show Properties
The settings for retrying failed webhook messages.
See RetrySettings
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 ID (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks).
An optional bucket sort key (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks).
The type of publishing for the webhook. If not set, it defaults to
SINGLE.
See PublishingTypeThe webhook group ID used to group webhooks together for ordered message sending.
This field is deprecated. GroupId is deprecated and will be removed in the future. Messages will be grouped by webhookId
A cursor for use in pagination.
Arguments
The cursor to use for pagination.
webhookId: The id of the webhook you want to retrieve.
bucketId: The bucketId of the webhooks you want to retrieve. Note that bucketId and webhookId are mutually exclusive, do not send both.
bucketSortkey: The bucketSortkey of the webhooks you want to retrieve.
limit: The maximum number of webhooks to return.