POSTCreate Flexible Webhook

Flexible Webhook APIhttps://web3.nodit.io/v1/aptos/mainnet/flexible-webhooks

Creates a Flexible Webhook subscription that matches Stream events against a CEL filter expression and delivers them to the endpoint you specify.

The signingKey is only exposed in plain text in this response. Store it securely.

Before creating a Flexible Webhook, call the Get Stream Schema API or List Flexible Streams API to check the available streamId values and the fields you can filter with a CEL expression.

chainstring (enum)required

Parameter to specify the target chain for the query.

networkstring (enum)required

Parameter to specify the network of the target chain. Supported networks may vary depending on the chain.

namestringrequired

The display name of the Flexible Webhook subscription. Up to 255 characters.

descriptionstring

An optional description of the Webhook subscription.

streamIdstringrequired

The unique ID of the on-chain data trackable via Flexible Webhook. You can look this up using the List Flexible Streams API.

filterExpressionstringrequired

A CEL (Common Expression Language) expression used to filter events. Use the List Flexible Streams API to view the stream's schema.

receiveFieldsstring[]

List of fields to include in the Webhook payload. If not specified, all fields from the stream are received.

destinationstringrequired

The endpoint URL to receive events.

reorgCorrectionEnabledboolean

Field that selects whether to apply reorg detection and correction. With this option enabled, when a reorg block occurs, the message affected by the reorg is re-sent under the same Sequence Number with the event.reorgRemoved: true tag. The information of the new block is then sent under a new Sequence Number.

subscriptionIdstring

The unique ID that identifies this Flexible Webhook.

projectIdstring

The ID of the project this Flexible Webhook belongs to.

accountIdstring

The ID of the account that created this Flexible Webhook.

namestring

The display name of the Flexible Webhook subscription.

descriptionstring

An optional description of the Flexible Webhook subscription.

chainstring

The name of the blockchain this Flexible Webhook is subscribed to.

networkstring

The network of the blockchain this Flexible Webhook is subscribed to.

streamIdstring

The unique ID of the on-chain data trackable via Flexible Webhook. You can look this up using the Get Stream Schema API or List Flexible Streams API.

streamSlugstring

The slug identifying this Stream.

filterExpressionstring

A CEL (Common Expression Language) expression used to filter events. Use the Get Stream Schema API or List Flexible Streams API to view the stream's schema.

receiveFieldsstring[]

List of fields to include in the Webhook payload. If not specified, all fields from the stream are received.

deliveryChannelstring (enum)

The delivery channel for event data.

destinationstring

The endpoint URL that receives events for this Flexible Webhook subscription.

signingKeystring

The signing key used to authenticate Flexible Webhook notifications. After receiving a notification, use this key to verify its validity.

The signing key is automatically generated when the Flexible Webhook is created and is only available in the creation response.

statusstring (enum)

The subscription status of this Flexible Webhook.

createdAtstring (date-time)

The date and time this Flexible Webhook subscription was created (ISO 8601 format).

updatedAtstring (date-time)

The date and time this Flexible Webhook subscription was last updated (ISO 8601 format).