Adobe I/O Events API (2.0)
List all Adobe I/O Events Providers entitled to the provided Organization ID
path Parameters
consumerOrgId required | string Your consumer organization Id (owning the Adobe I/O Events Provider) |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
Accept required | string Default: application/hal+json Content type accepted in the response. |
Responses
Response samples
- 200
{- "_embedded": {
- "providers": [
- {
- "id": "string",
- "label": "string",
- "description": "string",
- "source": "string",
- "docs_url": "string",
- "publisher": "string",
- "_embedded": {
- "eventmetadata": [
- {
- "description": "string",
- "label": "string",
- "event_code": "string",
- "_embedded": {
- "sample_event": {
- "format": "string",
- "sample_payload": "string",
- "_links": {
- "self": null
}
}
}, - "_links": {
- "rel:sample_event": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "rel:update": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
]
}, - "_links": {
- "rel:eventmetadata": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "rel:update": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
]
}, - "_links": {
- "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
View Adobe I/O Events Provider by ID
path Parameters
id required | string The requested provider Id |
query Parameters
eventmetadata | boolean Default: false The optional boolean to fetch or not this provider's event metadata |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
Accept required | string Default: application/hal+json Content type accepted in the response. |
Responses
Response samples
- 200
{- "id": "string",
- "label": "string",
- "description": "string",
- "source": "string",
- "docs_url": "string",
- "publisher": "string",
- "_embedded": {
- "eventmetadata": [
- {
- "description": "string",
- "label": "string",
- "event_code": "string",
- "_embedded": {
- "sample_event": {
- "format": "string",
- "sample_payload": "string",
- "_links": {
- "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
}, - "_links": {
- "rel:sample_event": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "rel:update": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
]
}, - "_links": {
- "rel:eventmetadata": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "rel:update": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
Create an Adobe I/O Events Provider
path Parameters
consumerOrgId required | string Your consumer organization Id (owning the Adobe I/O Events Provider) |
projectId required | string The project Id where the Adobe I/O Events Provider belongs |
workspaceId required | string The workspace Id where the Adobe I/O Events Provider belongs |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
Accept required | string Default: application/hal+json Content type accepted in the response. |
Request Body schema: application/json
The Input Model necessary to create an Adobe I/O Events Provider
label required | string [ 1 .. 255 ] characters [\w\s-_\.\(\)\,\@:'`?#!]+ The label of this Events Provider, as shown on the Adobe Developer Console |
description | string [ 0 .. 255 ] characters [\w\s-_\.\(\)\,\@:'`?#!]+ The description of this Events Provider, as shown on the Adobe Developer Console |
docs_url | string [ 0 .. 255 ] characters https?://(([^/:.\s]+(\.[^/:.\s]+)*)|([0-9](\.... The documentation url of this Events Provider, as shown on the Adobe Developer Console |
Responses
Request samples
- Payload
{- "label": "string",
- "description": "string",
- "docs_url": "string"
}
Response samples
- 201
{- "id": "string",
- "label": "string",
- "description": "string",
- "source": "string",
- "docs_url": "string",
- "publisher": "string",
- "_embedded": {
- "eventmetadata": [
- {
- "description": "string",
- "label": "string",
- "event_code": "string",
- "_embedded": {
- "sample_event": {
- "format": "string",
- "sample_payload": "string",
- "_links": {
- "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
}, - "_links": {
- "rel:sample_event": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "rel:update": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
]
}, - "_links": {
- "rel:eventmetadata": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "rel:update": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
Update an Adobe I/O Events Provider
path Parameters
consumerOrgId required | string Your consumer organization Id (owning the Adobe I/O Events Provider) |
projectId required | string The project Id where the Adobe I/O Events Provider belongs |
workspaceId required | string The workspace Id where the Adobe I/O Events Provider belongs |
providerId required | string The requested provider ID. |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
Accept required | string Default: application/hal+json Content type accepted in the response. |
Request Body schema: application/json
The Input Model necessary to update an Adobe I/O Events Provider
label required | string [ 1 .. 255 ] characters [\w\s-_\.\(\)\,\@:'`?#!]+ The label of this Events Provider, as shown on the Adobe Developer Console |
description | string [ 0 .. 255 ] characters [\w\s-_\.\(\)\,\@:'`?#!]+ The description of this Events Provider, as shown on the Adobe Developer Console |
docs_url | string [ 0 .. 255 ] characters https?://(([^/:.\s]+(\.[^/:.\s]+)*)|([0-9](\.... The documentation url of this Events Provider, as shown on the Adobe Developer Console |
Responses
Request samples
- Payload
{- "label": "string",
- "description": "string",
- "docs_url": "string"
}
Response samples
- 200
{- "id": "string",
- "label": "string",
- "description": "string",
- "source": "string",
- "docs_url": "string",
- "publisher": "string",
- "_embedded": {
- "eventmetadata": [
- {
- "description": "string",
- "label": "string",
- "event_code": "string",
- "_embedded": {
- "sample_event": {
- "format": "string",
- "sample_payload": "string",
- "_links": {
- "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
}, - "_links": {
- "rel:sample_event": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "rel:update": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
]
}, - "_links": {
- "rel:eventmetadata": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "rel:update": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
PATCH an Adobe I/O Events Provider using JSON Patch
path Parameters
consumerOrgId required | string Your consumer organization Id (owning the Adobe I/O Events Provider) |
projectId required | string The project Id where the Adobe I/O Events Provider belongs |
workspaceId required | string The workspace Id where the Adobe I/O Events Provider belongs |
providerId required | string The requested provider ID. |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
Accept required | string Default: application/hal+json Content type accepted in the response. |
Content-Type required | string Default: application/json-patch+json |
Request Body schema: application/json-patch+json
A JSON Patch of the Provider Input Model see https://tools.ietf.org/html/rfc6902, http://jsonpatch.com/
Responses
Request samples
- Payload
{ }
Response samples
- 200
{- "id": "string",
- "label": "string",
- "description": "string",
- "source": "string",
- "docs_url": "string",
- "publisher": "string",
- "_embedded": {
- "eventmetadata": [
- {
- "description": "string",
- "label": "string",
- "event_code": "string",
- "_embedded": {
- "sample_event": {
- "format": "string",
- "sample_payload": "string",
- "_links": {
- "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
}, - "_links": {
- "rel:sample_event": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "rel:update": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
]
}, - "_links": {
- "rel:eventmetadata": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "rel:update": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
Delete an Adobe I/O Events Provider by ID
path Parameters
consumerOrgId required | string Your consumer organization Id (owning the Adobe I/O Events Provider) |
projectId required | string The project Id where the Adobe I/O Events Provider belongs |
workspaceId required | string The workspace Id where the Adobe I/O Events Provider belongs |
providerId required | string The requested provider ID. |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
Accept required | string Default: application/hal+json Content type accepted in the response. |
Responses
Get the Event Metadata associated with a given Adobe I/O Events Provider ID and event code
path Parameters
providerId required | string The requested provider ID. |
eventCode required | string The requested eventmetadata event code |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
Accept required | string Default: application/hal+json Content type accepted in the response. |
Responses
Response samples
- 200
{- "description": "string",
- "label": "string",
- "event_code": "string",
- "_embedded": {
- "sample_event": {
- "format": "string",
- "sample_payload": "string",
- "_links": {
- "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
}, - "_links": {
- "rel:sample_event": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "rel:update": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
List the Event Metadata associated with a given Adobe I/O Events Provider ID
path Parameters
providerId required | string The requested provider ID. |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
Accept required | string Default: application/hal+json Content type accepted in the response. |
Responses
Response samples
- 200
{- "_embedded": {
- "eventmetadata": [
- {
- "description": "string",
- "label": "string",
- "event_code": "string",
- "_embedded": {
- "sample_event": {
- "format": "string",
- "sample_payload": "string",
- "_links": {
- "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
}, - "_links": {
- "rel:sample_event": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "rel:update": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
]
}, - "_links": {
- "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
Create an Adobe I/O Events Provider Event Metadata
path Parameters
consumerOrgId required | string Your consumer organization Id (owning the Adobe I/O Events Provider) |
projectId required | string The project Id where the Adobe I/O Events Provider belongs |
workspaceId required | string The workspace Id where the Adobe I/O Events Provider belongs |
providerId required | string The requested provider ID. |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
Accept required | string Default: application/hal+json Content type accepted in the response. |
Request Body schema: application/json
The Input Model necessary to create an Adobe I/O Events Provider Event Metadata
description required | string [ 1 .. 255 ] characters [\w\s-_\.\(\)\,\@:'`?#!]+ The description of this Event Metadata, as shown on the Adobe Developer Console |
label required | string [ 1 .. 255 ] characters [\w\s-_\.\(\)\,\@:'`?#!]+ The label of this Event Metadata, as shown on the Adobe Developer Console |
event_code required | string [ 1 .. 255 ] characters [\w-_\.]+ The event_code of this Event Metadata. This event_code describes the type of event. Ideally it should be prefixed with a reverse-DNS name (dictating the organization which defines the semantics of this event type) It is equivalent to the CloudEvents' type. see https://github.com/cloudevents/spec/blob/master/spec.md#type |
sample_event_template | string [ 0 .. 87382 ] characters ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-... An optional base64 encoded sample event template |
Responses
Request samples
- Payload
{- "description": "string",
- "label": "string",
- "event_code": "string",
- "sample_event_template": "string"
}
Response samples
- 201
{- "description": "string",
- "label": "string",
- "event_code": "string",
- "_embedded": {
- "sample_event": {
- "format": "string",
- "sample_payload": "string",
- "_links": {
- "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
}, - "_links": {
- "rel:sample_event": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "rel:update": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
Delete all Event Metadata associated with the given Adobe I/O Events Provider ID
path Parameters
consumerOrgId required | string Your consumer organization Id (owning the Adobe I/O Events Provider) |
projectId required | string The project Id where the Adobe I/O Events Provider belongs |
workspaceId required | string The workspace Id where the Adobe I/O Events Provider belongs |
providerId required | string The requested provider ID. |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
Accept required | string Default: application/hal+json Content type accepted in the response. |
Responses
Update an Adobe I/O Events Provider Event Metadata
path Parameters
consumerOrgId required | string Your consumer organization Id (owning the Adobe I/O Events Provider) |
projectId required | string The project Id where the Adobe I/O Events Provider belongs |
workspaceId required | string The workspace Id where the Adobe I/O Events Provider belongs |
providerId required | string The requested provider ID. |
eventCode required | string The requested eventmetadata event code |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
Accept required | string Default: application/hal+json Content type accepted in the response. |
Request Body schema: application/json
The Input Model necessary to update an Adobe I/O Events Provider Event Metadata
description required | string [ 1 .. 255 ] characters [\w\s-_\.\(\)\,\@:'`?#!]+ The description of this Event Metadata, as shown on the Adobe Developer Console |
label required | string [ 1 .. 255 ] characters [\w\s-_\.\(\)\,\@:'`?#!]+ The label of this Event Metadata, as shown on the Adobe Developer Console |
event_code required | string [ 1 .. 255 ] characters [\w-_\.]+ The event_code of this Event Metadata. This event_code describes the type of event. Ideally it should be prefixed with a reverse-DNS name (dictating the organization which defines the semantics of this event type) It is equivalent to the CloudEvents' type. see https://github.com/cloudevents/spec/blob/master/spec.md#type |
sample_event_template | string [ 0 .. 87382 ] characters ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-... An optional base64 encoded sample event template |
Responses
Request samples
- Payload
{- "description": "string",
- "label": "string",
- "event_code": "string",
- "sample_event_template": "string"
}
Response samples
- 200
{- "description": "string",
- "label": "string",
- "event_code": "string",
- "_embedded": {
- "sample_event": {
- "format": "string",
- "sample_payload": "string",
- "_links": {
- "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
}, - "_links": {
- "rel:sample_event": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "rel:update": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
PATCH an Adobe I/O Events Provider Event Metadata using JSON Patch
path Parameters
consumerOrgId required | string Your consumer organization Id (owning the Adobe I/O Events Provider) |
projectId required | string The project Id where the Adobe I/O Events Provider belongs |
workspaceId required | string The workspace Id where the Adobe I/O Events Provider belongs |
providerId required | string The requested provider ID. |
eventCode required | string The requested eventmetadata event code |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
Accept required | string Default: application/hal+json Content type accepted in the response. |
Content-Type required | string Default: application/json-patch+json |
Request Body schema: application/json-patch+json
A JSON Patch of the EventMetadata Input Model see https://tools.ietf.org/html/rfc6902, http://jsonpatch.com/
Responses
Request samples
- Payload
{ }
Response samples
- 200
{- "description": "string",
- "label": "string",
- "event_code": "string",
- "_embedded": {
- "sample_event": {
- "format": "string",
- "sample_payload": "string",
- "_links": {
- "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
}, - "_links": {
- "rel:sample_event": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "rel:update": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
Delete the Event Metadata associated with the given Adobe I/O Events Provider ID and event code
path Parameters
consumerOrgId required | string Your consumer organization Id (owning the Adobe I/O Events Provider) |
projectId required | string The project Id where the Adobe I/O Events Provider belongs |
workspaceId required | string The workspace Id where the Adobe I/O Events Provider belongs |
providerId required | string The requested provider ID. |
eventCode required | string The requested eventmetadata event code |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
Accept required | string Default: application/hal+json Content type accepted in the response. |
Responses
Get a sample event HAL JSON model of the provided Adobe I/O Events Provider ID and event code
path Parameters
providerId required | string The requested provider ID. |
eventCode required | string The requested eventmetadata event code |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
Accept required | string Default: application/hal+json Content type accepted in the response. |
Responses
Response samples
- 200
{- "format": "string",
- "sample_payload": "string",
- "_links": {
- "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
Check if a sample event is available for the provided Adobe I/O Events Provider ID and event code
path Parameters
providerId required | string The requested provider ID. |
eventCode required | string The requested eventmetadata event code |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
Responses
Create an event registration for a given workspace
path Parameters
consumerOrgId required | string Your consumer organization Id (owning the Adobe I/O Events Provider) |
projectId required | string The project Id where the Adobe I/O Events Provider belongs |
workspaceId required | string The workspace Id where the Adobe I/O Events Provider belongs |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
Request Body schema: application/json
The Input Model necessary to create an Adobe I/O Events Registration
client_id required | string [ 3 .. 255 ] characters Client id for which the registration is created, as obtained from Developer Console |
name required | string [ 3 .. 255 ] characters The name of the event registration which will be displayed on Developer Console |
description | string [ 0 .. 5000 ] characters The description of the registration |
webhook_url | string [ 0 .. 4000 ] characters (Optional) A valid webhook url where the events would be delivered |
required | Array of objects (EventsOfInterestInputModel) unique The events for which the registration is to be subscribed to |
delivery_type required | string Delivery type can be one of [ |
runtime_action | string [ 0 .. 255 ] characters (Optional) Runtime action to be invoked by the published events |
enabled | boolean Enable or disable the registration |
Responses
Request samples
- Payload
{- "client_id": "string",
- "name": "string",
- "description": "string",
- "webhook_url": "string",
- "events_of_interest": [
- {
- "provider": "string",
- "event_code": "string",
- "provider_id": "string"
}
], - "delivery_type": "string",
- "runtime_action": "string",
- "enabled": true
}
Response samples
- 201
{- "id": 0,
- "name": "string",
- "description": "string",
- "client_id": "string",
- "registration_id": "string",
- "events_of_interest": [
- {
- "provider": "string",
- "event_code": "string",
- "provider_id": "string",
- "event_label": "string",
- "event_description": "string",
- "provider_label": "string",
- "provider_description": "string",
- "provider_docs_url": "string",
- "event_delivery_format": "string"
}
], - "webhook_status": "string",
- "created_date": "string",
- "updated_date": "string",
- "consumer_id": "string",
- "project_id": "string",
- "workspace_id": "string",
- "webhook_url": "string",
- "delivery_type": "string",
- "runtime_action": "string",
- "enabled": true,
- "_links": {
- "rel:events": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "rel:trace": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
Get All Registrations
path Parameters
consumerOrgId required | string Your consumer organization Id (owning the Adobe I/O Events Provider) |
projectId required | string The project Id where the Adobe I/O Events Provider belongs |
workspaceId required | string The workspace Id where the Adobe I/O Events Provider belongs |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
Responses
Response samples
- 200
{- "_links": {
- "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}, - "_embedded": {
- "registrations": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "client_id": "string",
- "registration_id": "string",
- "events_of_interest": [
- {
- "provider": "string",
- "event_code": "string",
- "provider_id": "string",
- "event_label": "string",
- "event_description": "string",
- "provider_label": "string",
- "provider_description": "string",
- "provider_docs_url": "string",
- "event_delivery_format": "string"
}
], - "webhook_status": "string",
- "created_date": "string",
- "updated_date": "string",
- "consumer_id": "string",
- "project_id": "string",
- "workspace_id": "string",
- "webhook_url": "string",
- "delivery_type": "string",
- "runtime_action": "string",
- "enabled": true,
- "_links": {
- "rel:events": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "rel:trace": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
]
}
}
Get registration for registration id
path Parameters
consumerOrgId required | string Your consumer organization Id (owning the Adobe I/O Events Provider) |
projectId required | string The project Id where the Adobe I/O Events Provider belongs |
workspaceId required | string The workspace Id where the Adobe I/O Events Provider belongs |
registrationId required | string The registration Id associated with the registration |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
Responses
Response samples
- 200
{- "id": 0,
- "name": "string",
- "description": "string",
- "client_id": "string",
- "registration_id": "string",
- "events_of_interest": [
- {
- "provider": "string",
- "event_code": "string",
- "provider_id": "string",
- "event_label": "string",
- "event_description": "string",
- "provider_label": "string",
- "provider_description": "string",
- "provider_docs_url": "string",
- "event_delivery_format": "string"
}
], - "webhook_status": "string",
- "created_date": "string",
- "updated_date": "string",
- "consumer_id": "string",
- "project_id": "string",
- "workspace_id": "string",
- "webhook_url": "string",
- "delivery_type": "string",
- "runtime_action": "string",
- "enabled": true,
- "_links": {
- "rel:events": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "rel:trace": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
Updates an event registration specified by the Registration ID.
path Parameters
consumerOrgId required | string Your consumer organization Id (owning the Adobe I/O Events Provider) |
projectId required | string The project Id where the Adobe I/O Events Provider belongs |
workspaceId required | string The workspace Id where the Adobe I/O Events Provider belongs |
registrationId required | string The registration Id associated with the registration |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
Request Body schema: application/json
The Input Model necessary to create an Adobe I/O Events Registration
name required | string [ 3 .. 255 ] characters The name of the event registration which will be displayed on Developer Console |
description | string [ 0 .. 5000 ] characters The description of the registration |
webhook_url | string [ 0 .. 4000 ] characters (Optional) A valid webhook url where the events would be delivered |
required | Array of objects (EventsOfInterestInputModel) unique The events for which the registration is to be subscribed to |
delivery_type required | string Delivery type can be one of [ |
runtime_action | string [ 0 .. 255 ] characters (Optional) Runtime action to be invoked by the published events |
enabled | boolean Enable or disable the registration |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "webhook_url": "string",
- "events_of_interest": [
- {
- "provider": "string",
- "event_code": "string",
- "provider_id": "string"
}
], - "delivery_type": "string",
- "runtime_action": "string",
- "enabled": true
}
Response samples
- 200
{- "id": 0,
- "name": "string",
- "description": "string",
- "client_id": "string",
- "registration_id": "string",
- "events_of_interest": [
- {
- "provider": "string",
- "event_code": "string",
- "provider_id": "string",
- "event_label": "string",
- "event_description": "string",
- "provider_label": "string",
- "provider_description": "string",
- "provider_docs_url": "string",
- "event_delivery_format": "string"
}
], - "webhook_status": "string",
- "created_date": "string",
- "updated_date": "string",
- "consumer_id": "string",
- "project_id": "string",
- "workspace_id": "string",
- "webhook_url": "string",
- "delivery_type": "string",
- "runtime_action": "string",
- "enabled": true,
- "_links": {
- "rel:events": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "rel:trace": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
Patches an event registration.
path Parameters
consumerOrgId required | string Your consumer organization Id (owning the Adobe I/O Events Provider) |
projectId required | string The project Id where the Adobe I/O Events Provider belongs |
workspaceId required | string The workspace Id where the Adobe I/O Events Provider belongs |
registrationId required | string The registration Id associated with the registration |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
Request Body schema: application/json-patch+json
The Json Patch of the Registration Update Model to patch an existing registration
Responses
Request samples
- Payload
{ }
Response samples
- 200
{- "id": 0,
- "name": "string",
- "description": "string",
- "client_id": "string",
- "registration_id": "string",
- "events_of_interest": [
- {
- "provider": "string",
- "event_code": "string",
- "provider_id": "string",
- "event_label": "string",
- "event_description": "string",
- "provider_label": "string",
- "provider_description": "string",
- "provider_docs_url": "string",
- "event_delivery_format": "string"
}
], - "webhook_status": "string",
- "created_date": "string",
- "updated_date": "string",
- "consumer_id": "string",
- "project_id": "string",
- "workspace_id": "string",
- "webhook_url": "string",
- "delivery_type": "string",
- "runtime_action": "string",
- "enabled": true,
- "_links": {
- "rel:events": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "rel:trace": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
Delete registration by Registration ID
path Parameters
consumerOrgId required | string Your consumer organization Id (owning the Adobe I/O Events Provider) |
projectId required | string The project Id where the Adobe I/O Events Provider belongs |
workspaceId required | string The workspace Id where the Adobe I/O Events Provider belongs |
registrationId required | string The registration Id associated with the registration |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
Responses
Get all registrations for consumer org ID
path Parameters
consumerOrgId required | string Your consumer organization Id (owning the Adobe I/O Events Provider) |
query Parameters
page | integer <int32> Default: 0 The page number. Default value is 0 |
size | integer <int32> [ 1 .. 100 ] Default: 10 The size of each page. Default page size 10. Max allowed size 100 |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
Responses
Response samples
- 200
{- "page": {
- "size": 0,
- "number": 0,
- "numberOfElements": 0,
- "totalElements": 0,
- "totalPages": 0
}, - "_links": {
- "first": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "last": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "next": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "prev": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}, - "_embedded": {
- "registrations": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "client_id": "string",
- "registration_id": "string",
- "events_of_interest": [
- {
- "provider": "string",
- "event_code": "string",
- "provider_id": "string",
- "event_label": "string",
- "event_description": "string",
- "provider_label": "string",
- "provider_description": "string",
- "provider_docs_url": "string",
- "event_delivery_format": "string"
}
], - "webhook_status": "string",
- "created_date": "string",
- "updated_date": "string",
- "consumer_id": "string",
- "project_id": "string",
- "workspace_id": "string",
- "webhook_url": "string",
- "delivery_type": "string",
- "runtime_action": "string",
- "enabled": true,
- "_links": {
- "rel:events": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "rel:trace": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}, - "self": {
- "href": "string",
- "templated": true,
- "type": "string",
- "deprecation": "string",
- "name": "string",
- "title": "string",
- "hreflang": "string",
- "seen": "string"
}
}
}
]
}
}
Get tracing details for a specific event registration
path Parameters
consumerOrgId required | string Your consumer organization Id (owning the Adobe I/O Events Provider) |
credentialId required | string The credential Id associated with the credential in the project/workspace you created your registration in |
registrationId required | string The registration Id associated with the registration |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
x-ims-org-id | string |
Responses
Response samples
- 200
[- {
- "event": "string",
- "id": "string",
- "date": "string",
- "clientId": "string",
- "registrationId": "string",
- "trace": {
- "tracingRequest": {
- "requestUrl": "string",
- "requestMethod": "string",
- "contentType": "string",
- "requestBody": "string",
- "requestHeaders": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}, - "tracingResponse": {
- "responseBody": "string",
- "responseCode": 0,
- "responseTime": 0,
- "responseHeaders": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}, - "ts": 0,
- "deliveryTime": 0,
- "insightsInfo": [
- {
- "providerName": "string",
- "eventCode": "string",
- "eventIds": [
- "string"
]
}
]
}
}
]
Validate and get batch of events from journal
path Parameters
consumerOrgId required | string Your consumer organization Id (owning the Adobe I/O Events Provider) |
credentialId required | string The credential Id associated with the credential in the project/workspace you created your registration in |
registrationId required | string The registration Id associated with the registration |
query Parameters
limit | integer <int32> |
since | string |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
x-ims-org-id | string |
x-adobe-io-events-url-links | boolean |
Responses
Get batch of events for a registration from journal
path Parameters
consumerOrgId required | string Your consumer organization Id (owning the Adobe I/O Events Provider) |
credentialId required | string The credential Id associated with the credential in the project/workspace you created your registration in |
registrationId required | string The registration Id associated with the registration |
query Parameters
limit | integer <int32> |
since | string |
seek | string |
latest | boolean |
header Parameters
Authorization required | string Your authorization token in format "Bearer {token}" It must hold the |
x-api-key required | string API key whiltelisted at Adobe.io |
x-ims-org-id | string |
x-adobe-io-events-url-links | boolean |