POST /platform/v1/ens-callbacks

Overview

Registers a new callback to receive event notifications. Verify your callback before you can use it in a subscription.

JSON Parameters

NameTypeDescription
callbackNamestringRequiredName of the callback.
urlstringRequiredHTTPS URL of the customer callback that receives event notifications in the format https://host[/path]. A URL port and query string are not supported. The URL must be syntactically correct and not already registered. If the URL is already registered as a callback, an error occurs.
maxBatchSizeintegerMaximum number of events that this callback can receive in a single call. Must be at least 100 and no more than 1,000. Default is 1,000.

Usage

Your URL endpoint must be online and reachable before you create a callback. The Event Notification Service immediately attempts to post verification details to the endpoint.

If your callback doesn’t respond within 30 seconds or returns a non-200 HTTP status, the callback creation fails with a 400 HTTP status and the reason for the failure similar to the following.

Example Request

Example Response

HTTP Responses

ResponseReason
201 CreatedCallback created. Review example response.
304 No ChangeCallback already exists on the server.
400 Bad RequestUnable to process the request.
403 ForbiddenFailed to pass authorization.
500 Server ErrorInternal error