Skip to main content

Adobe I/O Events Component

Adobe I/O Events notifies you when changes occur. Use the Adobe I/O Events component to easily integrate events into your applications using Webhooks.

Component key: adobe-io-events

Description

Adobe I/O Events trigger when changes to content and data on Adobe's Experience Platform occur; or when predefined rules or thresholds have been met. Use the Adobe I/O Events Component to build reactive, near real-time event-driven applications with Adobe I/O Events.

API Documentation

This component was built using the Adobe I/O Events API.

Connections

Adobe I/O Connection

To establish an OAuth connection for your Adobe integration, follow these steps:

  1. Visit the Adobe Developer Console projects page by navigating to https://developer.adobe.com/console/projects.

  2. Create a new project by clicking the appropriate option.

  3. Click on "Add to project" to start configuring your project.

  4. Add the "I/O Management API" to your project. This API enables access to Adobe I/O services.

  5. Select "OAuth Server-to-Server authentication" as your preferred authentication method.

  6. Generate an access token from the connected credentials section. This step will also provide you with the Client ID required for your integration.

  7. In the Project overview view, you can download the project configuration JSON file. This file contains various values such as Organization ID, Project ID, and Workspace ID, which are essential for using the actions within your integration.

With these steps, you'll have set up an OAuth connection and obtained the necessary credentials for your Adobe I/O Events Component.

InputDefaultNotes
Client ID
string
/ Required
clientId
Client Identifier of your app for the Adobe I/O Connection
Client Secret
password
/ Required
clientSecret
Client Secret of your app for the Adobe I/O Connection
Headers
string
Hidden Field
Key Value List
headers
Additional header to supply to authorization requests
Scopes
string
scopes
adobeio_api, openid, AdobeID, read_organizations
Space separated OAuth 2.0 permission scopes for the Adobe I/O Connection
Token URL
string
/ Required
tokenUrl
https://ims-na1.adobelogin.com/ims/token/v3
The OAuth 2.0 Token URL for the Adobe I/O Connection

Triggers

Webhook

Receive and validate webhook requests from Adobe I/O for webhooks you configure | key: adobeIoEventWebhook


Actions

Create Events Provider

Create an Adobe I/O Events Provider | key: createEventsProvider

InputNotes
Connection
connection
/ Required
connection
 
Consumer Organization ID
string
/ Required
consumerOrgId
Your consumer organization Id
Provider Description
string
description
The description of this Events Provider, as shown on the Adobe Developer Console
Provider Documentation URL
string
docsUrl
The documentation url of this Events Provider, as shown on the Adobe Developer Console
Provider Label
string
/ Required
label
The label of this Events Provider, as shown on the Adobe Developer Console
Project ID
string
/ Required
projectId
The project Id
Workspace ID
string
/ Required
workspaceId
The workspace Id

Create Webhook/Journal Registration

Create a Webhook/Journal registration for given workspace | key: createWebhook

InputDefaultNotes
Connection
connection
/ Required
connection
 
 
Consumer Organization ID
string
/ Required
consumerOrgId
Your consumer organization Id
Delivery Type
string
/ Required
deliveryType
webhook
The delivery type of this registration.
Registration Description
string
/ Required
description
The description of this registration
Enabled
boolean
/ Required
enabled
Enable or disable the registration
Events of Interest
code
/ Required
eventsOfInterest
The events of interest for this registration. You can get the provider_id (provider not required) and event_code from the list of registrations available for your workspace by using the List All Registrations action.
Registration Name
string
/ Required
name
The name of the webhook registration which will be displayed on Developer Console
Project ID
string
/ Required
projectId
The project Id
Runtime Action
string
runtimeAction
Runtime action to be invoked by the published events
Webhook URL
string
/ Required
webhookUrl
The URL where the events will be delivered
Workspace ID
string
/ Required
workspaceId
The workspace Id

Delete Events Provider

Delete an Adobe I/O Events Provider by ID | key: deleteEventsProvider

InputNotes
Connection
connection
/ Required
connection
 
Consumer Organization ID
string
/ Required
consumerOrgId
Your consumer organization Id
Project ID
string
/ Required
projectId
The project Id
Provider ID
string
/ Required
providerId
The requested provider Id
Workspace ID
string
/ Required
workspaceId
The workspace Id

Delete Instanced Webhooks

Delete all Adobe I/O Webhook Registrations entitled to the provided Workspace ID | key: deleteInstancedWebhooks

InputNotes
Connection
connection
/ Required
connection
 
Consumer Organization ID
string
/ Required
consumerOrgId
Your consumer organization Id
Project ID
string
/ Required
projectId
The project Id
Workspace ID
string
/ Required
workspaceId
The workspace Id

Delete Registration (Webhook/Journal)

Delete Registration by Registration ID (Webhook/Journal) | key: deleteRegistration

InputNotes
Connection
connection
/ Required
connection
 
Consumer Organization ID
string
/ Required
consumerOrgId
Your consumer organization Id
Project ID
string
/ Required
projectId
The project Id
Registration ID
string
/ Required
registrationId
The registration Id associated with the registration
Workspace ID
string
/ Required
workspaceId
The workspace Id

Get Events Provider

View Adobe I/O Events Provider by ID | key: getEventsProvider

InputDefaultNotes
Connection
connection
/ Required
connection
 
 
Event Metadata
boolean
eventmetadata
The optional boolean to fetch or not this provider's event metadata
Provider ID
string
/ Required
id
The requested provider Id

List All Registrations

List all Adobe I/O Events Registrations entitled to the provided Workspace ID | key: listAllRegistrations

InputNotes
Connection
connection
/ Required
connection
 
Consumer Organization ID
string
/ Required
consumerOrgId
Your consumer organization Id
Project ID
string
/ Required
projectId
The project Id
Workspace ID
string
/ Required
workspaceId
The workspace Id

List Events Providers

List all Adobe I/O Events Providers entitled to the provided Organization ID | key: listEventsProviders

InputNotes
Connection
connection
/ Required
connection
 
Consumer Organization ID
string
/ Required
consumerOrgId
Your consumer organization Id

Raw Request

Send raw HTTP request to Adobe I/O Events | key: rawRequest

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Data
string
data
The HTTP body payload to send to the URL.
{"exampleKey": "Example Data"}
Debug Request
boolean
debugRequest
false
Enabling this flag will log out the current request.
 
File Data
string
Key Value List
fileData
File Data to be sent as a multipart form upload.
[{key: "example.txt", value: "My File Contents"}]
File Data File Names
string
Key Value List
fileDataFileNames
File names to apply to the file data inputs. Keys must match the file data keys above.
 
Form Data
string
Key Value List
formData
The Form Data to be sent as a multipart form upload.
[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header
string
Key Value List
headers
A list of headers to send with the request.
User-Agent: curl/7.64.1
Max Retry Count
string
maxRetries
0
The maximum number of retries to attempt.
 
Method
string
/ Required
method
The HTTP method to use.
 
Query Parameter
string
Key Value List
queryParams
A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
 
Response Type
string
/ Required
responseType
json
The type of data you expect in the response. You can request json, text, or binary data.
 
Retry On All Errors
boolean
retryAllErrors
false
If true, retries on all erroneous responses regardless of type.
 
Retry Delay (ms)
string
retryDelayMS
0
The delay in milliseconds between retries.
 
Timeout
string
timeout
The maximum time that a client will await a response to its request
2000
URL
string
/ Required
url
Input the path only (/{consumer_org_id}/providers), The base URL is already included (https://api.adobe.io/events), Authorization and x-api-key headers are already included. For example, to connect to https://api.adobe.io/events/{consumer_org_id}/providers, only /{consumer_org_id}/providers is entered in this field.
/{consumer_org_id}/providers
Use Exponential Backoff
boolean
useExponentialBackoff
false
Specifies whether to use a pre-defined exponential backoff strategy for retries.
 

Update Events Provider

Update an Adobe I/O Events Provider | key: updateEventsProvider

InputNotes
Connection
connection
/ Required
connection
 
Consumer Organization ID
string
/ Required
consumerOrgId
Your consumer organization Id
Provider Description
string
description
The description of this Events Provider, as shown on the Adobe Developer Console
Provider Documentation URL
string
docsUrl
The documentation url of this Events Provider, as shown on the Adobe Developer Console
Provider Label
string
/ Required
label
The label of this Events Provider, as shown on the Adobe Developer Console
Project ID
string
/ Required
projectId
The project Id
Provider ID
string
/ Required
providerId
The requested provider Id
Workspace ID
string
/ Required
workspaceId
The workspace Id