POST /platform/v1/ens-subscriptions

Overview

Creates a single subscription. A subscription indicates which event types to receive notifications for and which callback, or webhook, to receive them on. A new subscription can take up to two minutes to become active. You can create a subscription only for a verified callback and up to 200 subscriptions per callback.

JSON Parameters

NameTypeDescription
subscriptionNamestringRequiredName of the subscription. This name must be unique.
callbackIdstringRequiredUnique identifier of the callback that receives the notification events. This callback must already exist and must be verified.
eventCategoryTypesarrayRequiredComma-separated list of fully qualified event types for which you’re requesting notifications. Expressed as NotificationEventCategory.NotificationEventType. Review Supported Notification Events for a list of supported event categories and types.
filtersarrayEach string in the array is a key pair to filter on. Review Subscription Filters for a list of data items available for filtering.

Usage

The subscription you create is in active status, and event notifications are sent to the associated callback. Ensure that the callback you specify is ready to receive events before creating a subscription for it.

Example Request

Example Response

HTTP Responses

ResponseReason
201 CreatedSubscription is created. Review example response.
304 No ChangeSubscription already exists on the server.
400 Bad RequestInvalid request
403 ForbiddenFailed to pass authorization.
404 Not FoundCallback ID doesn't exist.
500 Server ErrorInternal error