Registrations

Create an event registration for a given workspace

Changed on
post/events/{consumerOrgId}/{projectId}/{workspaceId}/registrations

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /events/{consumerOrgId}/{projectId}/{workspaceId}/registrations
  • Auth: none declared. Required headers: Authorization, x-api-key

Path parameters

consumerOrgIdstring required

Consumer Organization ID

projectIdstring required

Project ID

workspaceIdstring required

Workspace ID

Headers

Authorizationstring required

Authorization token in the format "Bearer {token}". Must hold the I/O Management API scope (adobeio_api scope contained in s/ent_adobeio_sdk metascope).

x-api-keystring required

API Key whitelisted at Adobe.io

Request body

client_idstring required

Client id for which the registration is created, as obtained from Developer Console

namestring required

The name of the event registration which will be displayed on Developer Console

descriptionstring

The description of the registration

webhook_urlstring

(Optional) A valid webhook url where the events would be delivered

delivery_type'webhook' | 'webhook_batch' | 'journal' | 'aws_eventbridge' required

Delivery type can be one of [webhook, webhook_batch, journal, aws_eventbridge]

runtime_actionstring

(Optional) Runtime action to be invoked by the published events

enabledboolean

Enable or Disable the registration

Response

Successful creation

Changes

  • 6d675626c75cRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 24ffe2c85afdRevision changes
    • info

      endpoint added