Adobe I/O Events
npm install @adobe/aio-lib-events
 
``bash`
$ npm install @adobe/aio-lib-events
`javascript
const sdk = require('@adobe/aio-lib-events')
async function sdkTest() {
//initialize sdk
const client = await sdk.init('
}
`
2) Call methods using the initialized SDK
`javascript
const sdk = require('@adobe/aio-lib-events')
async function sdkTest() {
// initialize sdk
const client = await sdk.init('
// call methods
try {
// get profiles by custom filters
const result = await client.getSomething({})
console.log(result)
} catch (e) {
console.error(e)
}
}
`
3) Using the poller for journalling
`javascript
const sdk = require('@adobe/aio-lib-events')
async function sdkTest() {
// initialize sdk
const client = await sdk.init('
// get the journalling observable
const journalling = client.getEventsObservableFromJournal('
// call methods
const subscription = journalling.subscribe({
next: (v) => console.log(v), // Action to be taken on event
error: (e) => console.log(e), // Action to be taken on error
complete: () => console.log('Complete') // Action to be taken on complete
})
// To stop receiving events from this subscription based on a timeout
setTimeout(() => subscription.unsubscribe(),
}
`
One observable can have multiple subscribers. Each subscription can be handled differently.
For more details on using the poller for Journalling check getEventsObservableFromJournal
This class provides methods to call your Adobe I/O Events APIs.
Before calling any method initialize the instance by calling the init method on it
with valid values for organizationId, apiKey, accessToken and optional http options such as timeout
and max number of retries
Promise.<EventsCoreAPI>Returns a Promise that resolves with a new EventsCoreAPI object.
objectobjectobjectobjectobjectobjectobjectobjectobjectobjectobject method on it
with valid values for organizationId, apiKey, accessToken and optional http options such as timeout
and max number of retriesKind: global class
* EventsCoreAPI
* .httpOptions
* .organizationId
* .apiKey
* .accessToken
* [.init(organizationId, apiKey, accessToken, [httpOptions])](#EventsCoreAPI+init) ⇒ Promise.<EventsCoreAPI>
* .getAllProviders(consumerOrgId, providerOptions) ⇒ Promise.<object>
* [.getProvider(providerId, [fetchEventMetadata])](#EventsCoreAPI+getProvider) ⇒ Promise.<object>
* .createProvider(consumerOrgId, projectId, workspaceId, body) ⇒ Promise.<object>
* .updateProvider(consumerOrgId, projectId, workspaceId, providerId, body) ⇒ Promise.<object>
* .deleteProvider(consumerOrgId, projectId, workspaceId, providerId) ⇒ Promise.<object>
* .getProviderMetadata() ⇒ Promise.<object>
* .getAllEventMetadataForProvider(providerId) ⇒ Promise.<object>
* .getEventMetadataForProvider(providerId, eventCode) ⇒ Promise.<object>
* .createEventMetadataForProvider(consumerOrgId, projectId, workspaceId, providerId, body) ⇒ Promise.<object>
* .updateEventMetadataForProvider(consumerOrgId, projectId, workspaceId, providerId, eventCode, body) ⇒ Promise.<object>
* .deleteEventMetadata(consumerOrgId, projectId, workspaceId, providerId, eventCode) ⇒ Promise.<object>
* .deleteAllEventMetadata(consumerOrgId, projectId, workspaceId, providerId) ⇒ Promise.<object>
* .createRegistration(consumerOrgId, projectId, workspaceId, body) ⇒ Promise.<object>
* .updateRegistration(consumerOrgId, projectId, workspaceId, registrationId, body) ⇒ Promise.<object>
* .getRegistration(consumerOrgId, projectId, workspaceId, registrationId) ⇒ Promise.<object>
* .getAllRegistrationsForWorkspace(consumerOrgId, projectId, workspaceId) ⇒ Promise.<object>
* [.getAllRegistrationsForOrg(consumerOrgId, [page])](#EventsCoreAPI+getAllRegistrationsForOrg) ⇒ Promise.<object>
* .deleteRegistration(consumerOrgId, projectId, workspaceId, registrationId) ⇒ Promise.<object>
* .publishEvent(cloudEvent) ⇒ Promise.<string>
* [.getEventsFromJournal(journalUrl, [eventsJournalOptions], [fetchResponseHeaders])](#EventsCoreAPI+getEventsFromJournal) ⇒ Promise.<object>
* [.getEventsObservableFromJournal(journalUrl, [eventsJournalOptions], [eventsJournalPollingOptions])](#EventsCoreAPI+getEventsObservableFromJournal) ⇒ Observable
* .verifyDigitalSignatureForEvent(event, recipientClientId, signatureOptions) ⇒ boolean
$3
Http options {retries, timeout}Kind: instance property of EventsCoreAPI
$3
The organization id from your integrationKind: instance property of EventsCoreAPI
$3
The api key from your integrationKind: instance property of EventsCoreAPI
$3
The JWT Token for the integration with IO Management API scopeKind: instance property of EventsCoreAPI
$3
Initialize SDK.Kind: instance method of EventsCoreAPI
Returns: Promise.<EventsCoreAPI> - returns object of the class EventsCoreAPI
| Param | Type | Description |
| --- | --- | --- |
| organizationId | string | The organization id from your integration |
| apiKey | string | The api key from your integration |
| accessToken | string | JWT Token for the integration with IO Management API scope |
| [httpOptions] | EventsCoreAPIOptions | Options to configure API calls |
$3
Fetch all the providersKind: instance method of EventsCoreAPI
Returns: Promise.<object> - Returns list of providers for the org
| Param | Type | Description |
| --- | --- | --- |
| consumerOrgId | string | Consumer Org Id from the console |
| providerOptions | ProviderOptions | Provider options |
$3
Fetch a providerKind: instance method of EventsCoreAPI
Returns: Promise.<object> - Returns the provider specified by the provider id
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| providerId | string | | The id that uniquely identifies the provider to be fetched |
| [fetchEventMetadata] | boolean | false | Set this to true if you want to fetch the associated eventmetadata of the provider |
$3
Create a new provider given the provider detailsKind: instance method of EventsCoreAPI
Returns: Promise.<object> - Returns the details of the provider created
| Param | Type | Description |
| --- | --- | --- |
| consumerOrgId | string | Consumer Org Id from the console |
| projectId | string | Project Id from the console |
| workspaceId | string | Workspace Id from the console |
| body | ProviderInputModel | Json data that describes the provider |
$3
Update a provider given the id and provider detailsKind: instance method of EventsCoreAPI
Returns: Promise.<object> - Returns the details of the provider updated
| Param | Type | Description |
| --- | --- | --- |
| consumerOrgId | string | Consumer Org Id from the console |
| projectId | string | Project Id from the console |
| workspaceId | string | Workspace Id from the console |
| providerId | string | The id that uniquely identifies the provider to be updated |
| body | ProviderInputModel | Json data that describes the provider |
$3
Delete a provider given the idKind: instance method of EventsCoreAPI
Returns: Promise.<object> - Returns an empty object if the deletion was successful
| Param | Type | Description |
| --- | --- | --- |
| consumerOrgId | string | Consumer Org Id from the console |
| projectId | string | Project Id from the console |
| workspaceId | string | Workspace Id from the console |
| providerId | string | The id that uniquely identifies the provider to be deleted |
$3
Kind: instance method of EventsCoreAPI
Returns: Promise.<object> - Returns the list of all entitled provider metadata for the org
$3
Get all event metadata for a providerKind: instance method of EventsCoreAPI
Returns: Promise.<object> - List of all event metadata of the provider
| Param | Type | Description |
| --- | --- | --- |
| providerId | string | The id that uniquely identifies the provider whose event metadata is to be fetched |
$3
Get an event metadata for given provider and event codeKind: instance method of EventsCoreAPI
Returns: Promise.<object> - Event metadata that corresponds to the specified event code
| Param | Type | Description |
| --- | --- | --- |
| providerId | string | The id that uniquely identifies the provider whose event metadata is to be fetched |
| eventCode | string | The specific event code for which the details of the event metadata is to be fetched |
$3
Create an event metadata for a providerKind: instance method of EventsCoreAPI
Returns: Promise.<object> - Details of the event metadata created
| Param | Type | Description |
| --- | --- | --- |
| consumerOrgId | string | Consumer Org Id from the console |
| projectId | string | Project Id from the console |
| workspaceId | string | Workspace Id from the console |
| providerId | string | provider for which the event metadata is to be added |
| body | EventMetadataInputModel | Json data that describes the event metadata |
$3
Update the event metadata for a providerKind: instance method of EventsCoreAPI
Returns: Promise.<object> - Details of the event metadata updated
| Param | Type | Description |
| --- | --- | --- |
| consumerOrgId | string | Consumer Org Id from the console |
| projectId | string | Project Id from the console |
| workspaceId | string | Workspace Id from the console |
| providerId | string | provider for which the event metadata is to be updated |
| eventCode | string | eventCode of the event metadata to be updated |
| body | EventMetadataInputModel | Json data that describes the event metadata |
$3
Delete an event metadata of a providerKind: instance method of EventsCoreAPI
Returns: Promise.<object> - Empty object if deletion was successful
| Param | Type | Description |
| --- | --- | --- |
| consumerOrgId | string | Consumer Org Id from the console |
| projectId | string | Project Id from the console |
| workspaceId | string | Workspace Id from the console |
| providerId | string | provider for which the event metadata is to be updated |
| eventCode | string | eventCode of the event metadata to be updated |
$3
Delete all event metadata of a providerKind: instance method of EventsCoreAPI
Returns: Promise.<object> - Empty object if deletion was successful
| Param | Type | Description |
| --- | --- | --- |
| consumerOrgId | string | Consumer Org Id from the console |
| projectId | string | Project Id from the console |
| workspaceId | string | Workspace Id from the console |
| providerId | string | provider for which the event metadata is to be updated |
$3
Create a webhook or journal registrationKind: instance method of EventsCoreAPI
Returns: Promise.<object> - Details of the webhook/journal registration created
| Param | Type | Description |
| --- | --- | --- |
| consumerOrgId | string | Consumer Org Id from the console |
| projectId | string | Project Id from the console |
| workspaceId | string | Workspace Id from the console |
| body | RegistrationCreateModel | Json data contains details of the registration |
$3
Update a webhook or journal registrationKind: instance method of EventsCoreAPI
Returns: Promise.<object> - Details of the webhook/journal registration to be updated
| Param | Type | Description |
| --- | --- | --- |
| consumerOrgId | string | Consumer Org Id from the console |
| projectId | string | Project Id from the console |
| workspaceId | string | Workspace Id from the console |
| registrationId | string | Registration id whose details are to be fetched |
| body | RegistrationUpdateModel | Json data contains details of the registration |
$3
Get registration details for a given registrationKind: instance method of EventsCoreAPI
Returns: Promise.<object> - Details of the webhook/journal registration
| Param | Type | Description |
| --- | --- | --- |
| consumerOrgId | string | Consumer Org Id from the console |
| projectId | string | Project Id from the console |
| workspaceId | string | Workspace Id from the console |
| registrationId | string | Registration id whose details are to be fetched |
$3
Get all registration details for a workspaceKind: instance method of EventsCoreAPI
Returns: Promise.<object> - List of all webhook/journal registrations
| Param | Type | Description |
| --- | --- | --- |
| consumerOrgId | string | Consumer Org Id from the console |
| projectId | string | Project Id from the console |
| workspaceId | string | Workspace Id from the console |
$3
Get all registration details for an orgKind: instance method of EventsCoreAPI
Returns: Promise.<object> - Paginated response of all webhook/journal registrations for an org
| Param | Type | Description |
| --- | --- | --- |
| consumerOrgId | string | Consumer Org Id from the console |
| [page] | Page | page size and page number |
$3
Delete webhook registrationKind: instance method of EventsCoreAPI
Returns: Promise.<object> - Empty object if deletion was successful
| Param | Type | Description |
| --- | --- | --- |
| consumerOrgId | string | Consumer Org Id from the console |
| projectId | string | Project Id from the console |
| workspaceId | string | Workspace Id from the console |
| registrationId | string | Id of the registration to be deleted |
$3
Publish Cloud EventsEvent publishers can publish events to the Adobe I/O Events using this SDK. The events should follow Cloud Events 1.0 specification: https://github.com/cloudevents/spec/blob/v1.0/spec.md.
As of now, only application/json is accepted as the content-type for the "data" field of the cloud event.
If retries are set, publish events are retried on network issues, 5xx and 429 error response codes.
Kind: instance method of EventsCoreAPI
Returns: Promise.<string> - Returns OK/ undefined in case of success and error in case of failure
| Param | Type | Description |
| --- | --- | --- |
| cloudEvent | object | Object to be published to event receiver in cloud event format |
$3
Get events from a journal.Kind: instance method of EventsCoreAPI
Returns: Promise.<object> - with the response json includes events and links (if available)
| Param | Type | Description |
| --- | --- | --- |
| journalUrl | string | URL of the journal or 'next' link to read from (required) |
| [eventsJournalOptions] | EventsJournalOptions | Query options to send with the URL |
| [fetchResponseHeaders] | boolean | Set this to true if you want to fetch the complete response headers |
$3
getEventsObservableFromJournal returns an RxJS ObservableOne can go through the extensive documentation on RxJS in order to learn more
and leverage the various RxJS Operators to act on emitted events.
Kind: instance method of EventsCoreAPI
Returns: Observable - observable to which the user can subscribe to in order to listen to events
| Param | Type | Description |
| --- | --- | --- |
| journalUrl | string | URL of the journal or 'next' link to read from (required) |
| [eventsJournalOptions] | EventsJournalOptions | Query options to send with the Journal URL |
| [eventsJournalPollingOptions] | EventsJournalPollingOptions | Journal polling options |
$3
Authenticating events by verifying digital signatureKind: instance method of EventsCoreAPI
Returns: boolean - If signature matches return true else return false
| Param | Type | Description |
| --- | --- | --- |
| event | \* | JSON payload delivered to the registered webhook URL |
| recipientClientId | \* | Target recipient client id retrieved from the Adobe I/O Console integration |
| signatureOptions | \* | map of all digital signature header values consisting fields as below digiSignature1 : Value of digital signature retrieved from the x-adobe-digital-signature1 header in each POST request to webhook digiSignature2 : Value of digital signature retrieved from the x-adobe-digital-signature2 header in each POST request to webhook publicKeyPath1 : Relative path of ioevents public key retrieved from the x-adobe-public-key1-path header in each POST request to webhook publicKeyPath2 : Relative path of ioevents public key retrieved from the x-adobe-public-key2-path header in each POST request to webhook |
init(organizationId, apiKey, accessToken, [httpOptions]) ⇒ Promise.<EventsCoreAPI>
Returns a Promise that resolves with a new EventsCoreAPI object.Kind: global function
Returns: Promise.<EventsCoreAPI> - returns object of the class EventsCoreAPI
| Param | Type | Description |
| --- | --- | --- |
| organizationId | string | The organization id from your integration |
| apiKey | string | The api key from your integration |
| accessToken | string | JWT Token for the integration with IO Management API scope |
| [httpOptions] | EventsCoreAPIOptions | Options to configure API calls |
EventsCoreAPIOptions : object
Kind: global typedef
Properties| Name | Type | Description |
| --- | --- | --- |
| [timeout] | number | Http request timeout in ms (optional) |
| [retries] | number | Number of retries in case of 5xx errors. Default 0 (optional) |
| [eventsBaseURL] | string | Base URL for Events Default https://api.adobe.io (optional) |
| [eventsIngressURL] | string | Ingress URL for Events. Default https://eventsingress.adobe.io (optional) |
ProviderFilterOptions : object
Kind: global typedef
Properties| Name | Type | Description |
| --- | --- | --- |
| [providerMetadataId] | string | Fetch by providerMetadataId for the consumer org |
| [instanceId] | string | For Self registered providers, instanceId is a must while fetching by providerMetadataId |
| [providerMetadataIds] | Array.<string> | Fetch all providers ( and all instances ) for the list of provider metadata ids |
ProviderOptions : object
Kind: global typedef
Properties| Name | Type | Description |
| --- | --- | --- |
| fetchEventMetadata | boolean | Option to fetch event metadata for each of the the providers in the list |
| filterBy | ProviderFilterOptions | Provider filtering options based on either (providerMetadataId and instanceId) or list of providerMetadataIds |
ProviderInputModel : object
Kind: global typedef
Properties| Name | Type | Description |
| --- | --- | --- |
| label | string | The label of this Events Provider |
| [description] | string | The description of this Events Provider |
| [docs_url] | string | The documentation url of this Events Provider |
EventMetadataInputModel : object
Kind: global typedef
Properties| Name | Type | Description |
| --- | --- | --- |
| label | string | The description of this Event Metadata |
| description | string | The label of this Event Metadata |
| event_code | string | 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 | An optional base64 encoded sample event template |
EventsOfInterest : object
Kind: global typedef
Properties| Name | Type | Description |
| --- | --- | --- |
| provider_id | string | The id of the provider of the events to be subscribed |
| event_code | string | The requested valid event code belonging to the provider |
RegistrationCreateModel : object
Kind: global typedef
Properties| Name | Type | Description |
| --- | --- | --- |
| client_id | string | Client id for which the registration is created |
| name | string | The name of the registration |
| description | string | The description of the registration |
| [webhook_url] | string | A valid webhook url where the events would be delivered for webhook or webhook_batch delivery_type |
| events_of_interest | Array.<EventsOfInterest> | The events for which the registration is to be subscribed to |
| delivery_type | string | Delivery type can either be webhook|webhook_batch|journal. |
| [enabled] | string | Enable or disable the registration. Default true. |
RegistrationUpdateModel : object
Kind: global typedef
Properties| Name | Type | Description |
| --- | --- | --- |
| name | string | The name of the registration |
| description | string | The description of the registration |
| [webhook_url] | string | A valid webhook url where the events would be delivered for webhook or webhook_batch delivery_type |
| events_of_interest | Array.<EventsOfInterest> | The events for which the registration is to be subscribed to |
| delivery_type | string | Delivery type can either be webhook|webhook_batch|journal. |
| [enabled] | string | Enable or disable the registration. Default true. |
Page : object
Kind: global typedef
Properties| Name | Type | Description |
| --- | --- | --- |
| [page] | number | page number to be fetched. Default 0 (optional) |
| [size] | number | size of each page. Default 10 (optional) |
EventsJournalOptions : object
Kind: global typedef
Properties| Name | Type | Description |
| --- | --- | --- |
| [latest] | boolean | Retrieve latest events (optional) |
| [since] | string | Position at which to start fetching the events from (optional) |
| [limit] | number | Maximum number of events to retrieve (optional) |
EventsJournalPollingOptions : object
Kind: global typedef
Properties| Name | Type | Description |
| --- | --- | --- |
| [interval] | number | Interval at which to poll the journal; If not provided, a default value will be used (optional) |
$3
`bash
LOG_LEVEL=debug
`Prepend the
environment variable and debug` value to the call that invokes your function, on the command line. This should output a lot of debug data for your SDK calls.Contributions are welcome! Read the Contributing Guide for more information.
This project is licensed under the Apache V2 License. See LICENSE for more information.