Providers

Create an event provider

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

Request

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

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

Acceptstring required

Content type accepted in the response.

Request body

labelstring required

The label of this event provider, as shown on the Adobe Developer Console

descriptionstring

The description of this event provider, as shown on the Adobe Developer Console. If omitted, the default description defined in the provider metadata will be used.

docs_urlstring

The documentation URL of this event provider, as shown on the Adobe Developer Console. If omitted, the default documentation URL defined in the provider metadata will be used.

provider_metadatastring

The provider metadata ID; optional. If omitted, the default 3rd_party_custom_events will be used.

instance_idstring

A technical instance ID; optional. If omitted and provider_metadata is 3rd_party_custom_events, a random UUID is generated; otherwise, you must specify a custom value, which must be unique at the provider_metadata level.

data_residency_regionstring

The data residency region; optional. If omitted, the default VA6 will be used. Currently we only support two regions: US (VA6) and Europe (IRL1). This defines where your events are stored and processed.

Example request

{
  "label": "My Event Provider",
  "description": "A description for this event provider",
  "docs_url": "https://developer.adobe.com/events/docs",
  "provider_metadata": "3rd_party_custom_events",
  "instance_id": "instance-1",
  "data_residency_region": "VA6"
}

Response

The created event provider.

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

    • info

      added the non-success response with the status