POST /platform/v1/ens-subscriptions
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.
Name | Type | Description | |
---|---|---|---|
subscriptionName | string | Required | Name of the subscription. This name must be unique. |
callbackId | string | Required | Unique identifier of the callback that receives the notification events. This callback must already exist and must be verified. |
eventCategoryTypes | array | Required | Comma-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. |
filters | array | Each string in the array is a key |
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.
Response | Reason |
---|---|
201 Created | Subscription is created. Review example response. |
304 No Change | Subscription already exists on the server. |
400 Bad Request | Invalid request |
403 Forbidden | Failed to pass authorization. |
| | 404 Not Found | Callback ID doesn't exist. | | 500 Server Error | Internal error |