API docs by Redocly

Akeneo - Event Platform Management API (1.0.0)

Download OpenAPI specification:

Akeneo Support: contact@akeneo.com URL: https://www.akeneo.com/support-help-center/

How to use this API

For detailed documentation about the prerequisites and the concepts, please refer to the official Akeneo Event Platform documentation

Using Postman

A Postman collection is available to ease the manipulation of this API.

By providing correct Postman variable values you'll benefit from automatic authentication to the API.

Import Postman environment variables template

The best way to start is by importing the postman environment template.

You can download it here, then import it in Postman.

Subscriber

A Subscriber holds the Subscriptions for a given client id of a PIM

Create a Subcriber

Create a Subscriber which is linked to a specific client id of a PIM.

It holds all the Subscriptions.

Authorizations:
pimAccessToken
header Parameters
x-pim-client-id
required
string

Client ID of the PIM Connection, App or Custom App for which the Access token has been issued

x-pim-url
required
string <uri>

PIM Url that issued the access token

Request Body schema: application/json
required

The name property is here to describe the Subscriber with a human readable sentence. Can be useful if you're in charge of a multitenant App to quickly see which Subscriber refers to what, it's purely informative and have not impact on the Event Platform features. It's up to you to put relevant information such as the name of your App concatenated with the tenant, example:

  • Shopify App - ACME company
  • Micro service for ACME slack notifications

We will use the technical_email to send you notifications on some decisions made by the platform.

name
string

The subscriber name

object

Responses

Request samples

Content type
application/json
{
  • "name": "translation app",
  • "contact": {
    }
}

Response samples

Content type
application/json
{
  • "id": "018e1ec5-29da-78ad-aae6-92065b9ca2a5",
  • "subject": "https://example.cloud.akeneo.com/",
  • "status": "active",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "name": "translation app",
  • "contact": {
    }
}

Retrieve all Subscribers

Retrieve all active Subscribers associated with your credentials.

Authorizations:
pimAccessToken
header Parameters
x-pim-client-id
required
string

Client ID of the PIM Connection, App or Custom App for which the Access token has been issued

x-pim-url
required
string <uri>

PIM Url that issued the access token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a Subscriber

Get a Subscriber configuration by its identifier

Authorizations:
pimAccessToken
path Parameters
subscriber_id
required
string <uuid>

The unique identifier of the subscriber.

header Parameters
x-pim-client-id
required
string

Client ID of the PIM Connection, App or Custom App for which the Access token has been issued

x-pim-url
required
string <uri>

PIM Url that issued the access token

Responses

Response samples

Content type
application/json
{
  • "id": "018e1ec5-29da-78ad-aae6-92065b9ca2a5",
  • "subject": "https://example.cloud.akeneo.com/",
  • "status": "active",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "name": "translation app",
  • "contact": {
    }
}

Update a Subscriber

You can update a Subscriber when you want to change it's name or change the contact email.

Authorizations:
pimAccessToken
path Parameters
subscriber_id
required
string <uuid>

The unique identifier of the subscriber.

header Parameters
x-pim-client-id
required
string

Client ID of the PIM Connection, App or Custom App for which the Access token has been issued

x-pim-url
required
string <uri>

PIM Url that issued the access token

Request Body schema: application/json
required

You can update any data belonging to the following payload.

name
string

The subscriber name

object

Responses

Request samples

Content type
application/json
{
  • "name": "translation app",
  • "contact": {
    }
}

Response samples

Content type
application/json
{
  • "id": "018e1ec5-29da-78ad-aae6-92065b9ca2a5",
  • "subject": "https://example.cloud.akeneo.com/",
  • "status": "active",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "name": "translation app",
  • "contact": {
    }
}

Delete a Subscriber

You need to manage the lifecycle of the Subscriber, you can delete a Subscriber when it is not needed anymore.

Authorizations:
pimAccessToken
path Parameters
subscriber_id
required
string <uuid>

The unique identifier of the subscriber.

header Parameters
x-pim-client-id
required
string

Client ID of the PIM Connection, App or Custom App for which the Access token has been issued

x-pim-url
required
string <uri>

PIM Url that issued the access token

Responses

Response samples

Content type
application/json
{
  • "id": "018e1ec5-29da-78ad-aae6-92065b9ca2a5",
  • "subject": "https://example.cloud.akeneo.com/",
  • "status": "active",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "name": "translation app",
  • "contact": {
    }
}

Subscription

A Subscription defines the event you want to Subscribe and the destination where they will be sent

Create a Subscription

Create a Subscription with a configuration of a destination and the list of events the destination wants to receive.

Authorizations:
pimAccessToken
path Parameters
subscriber_id
required
string <uuid>

The unique identifier of the subscriber.

header Parameters
x-pim-client-id
required
string

Client ID of the PIM Connection, App or Custom App for which the Access token has been issued

x-pim-url
required
string <uri>

PIM Url that issued the access token

Request Body schema: application/json
required

Respect the following payload to create and configure a Subscription.

Part of the payload is specific to the destination you choose.

One of
source
string
Default: "pim"
subject
string <uri>

Url of the PIM

events
Array of strings

The list of event types that the subscription is configured to receive.

type
string
Enum: "pubsub" "https"

The destination type

object

Responses

Request samples

Content type
application/json
Example
{}

Response samples

Content type
application/json
Example
{}

Retrieve all Subscriptions of a Subscriber

Retrieve the list of all Subscriptions for a specific Subscriber.

Authorizations:
pimAccessToken
path Parameters
subscriber_id
required
string <uuid>

The unique identifier of the subscriber.

header Parameters
x-pim-client-id
required
string

Client ID of the PIM Connection, App or Custom App for which the Access token has been issued

x-pim-url
required
string <uri>

PIM Url that issued the access token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a Subscription

Retrieve a Subscription detail by its identifier

Authorizations:
pimAccessToken
path Parameters
subscriber_id
required
string <uuid>

The unique identifier of the subscriber.

subscription_id
required
string <uuid>

The unique identifier of the subscription.

header Parameters
x-pim-client-id
required
string

Client ID of the PIM Connection, App or Custom App for which the Access token has been issued

x-pim-url
required
string <uri>

PIM Url that issued the access token

Responses

Response samples

Content type
application/json
Example
{}

Update a Subscription

Update a Subscription configuration.

You can expect a slight delay between the update and the application by the platform.

Authorizations:
pimAccessToken
path Parameters
subscriber_id
required
string <uuid>

The unique identifier of the subscriber.

subscription_id
required
string <uuid>

The unique identifier of the subscription.

header Parameters
x-pim-client-id
required
string

Client ID of the PIM Connection, App or Custom App for which the Access token has been issued

x-pim-url
required
string <uri>

PIM Url that issued the access token

Request Body schema: application/json
required

The following payload data can be updated

One of
source
string
Default: "pim"
subject
string <uri>

Url of the PIM

events
Array of strings

The list of event types that the subscription is configured to receive.

type
string
Enum: "pubsub" "https"

The destination type

object

Responses

Request samples

Content type
application/json
Example
{}

Response samples

Content type
application/json
Example
{}

Delete a Subscription

A deleted Subscription can't be re-activated again.

Ensure to suspend it if you want to pause the emission of event.

Authorizations:
pimAccessToken
path Parameters
subscriber_id
required
string <uuid>

The unique identifier of the subscriber.

subscription_id
required
string <uuid>

The unique identifier of the subscription.

header Parameters
x-pim-client-id
required
string

Client ID of the PIM Connection, App or Custom App for which the Access token has been issued

x-pim-url
required
string <uri>

PIM Url that issued the access token

Responses

Response samples

Content type
application/json
Example
{}

Suspend a Subscription

Suspend a Subscription when you want to pause the emission of events.

During the time of suspension, new events will be losts. Ensure to resume it once you're ready to receive events again.

Authorizations:
pimAccessToken
path Parameters
subscriber_id
required
string <uuid>

The unique identifier of the subscriber.

subscription_id
required
string <uuid>

The unique identifier of the subscription.

header Parameters
x-pim-client-id
required
string

Client ID of the PIM Connection, App or Custom App for which the Access token has been issued

x-pim-url
required
string <uri>

PIM Url that issued the access token

Responses

Response samples

Content type
application/json
Example
{}

Resume a suspended Subscription

A suspended Subscription can be resume with a call to this endpoint.

Suspension can be done by you, or can be decided by the platform itself depending on the behavior of your destination. You can find details in our official documentation.

Authorizations:
pimAccessToken
path Parameters
subscriber_id
required
string <uuid>

The unique identifier of the subscriber.

subscription_id
required
string <uuid>

The unique identifier of the subscription.

header Parameters
x-pim-client-id
required
string

Client ID of the PIM Connection, App or Custom App for which the Access token has been issued

x-pim-url
required
string <uri>

PIM Url that issued the access token

Responses

Response samples

Content type
application/json
Example
{}

Logs

Retrieve Logs

Retrieve a paginated list of logs based on optional filters.

Authorizations:
pimAccessToken
query Parameters
page
integer
Example: page=1

The page number for pagination. Starts at 1.

limit
integer
Example: limit=10

The number of logs to retrieve per page. Defaults to 10.

order
string
Enum: "asc" "desc"
Example: order=asc

Specifies the sort order of the logs. Accepted values are asc for ascending order and desc for descending order. Defaults to desc if not provided.

start_date
string <date-time>
Example: start_date=2024-11-15T00:00:00Z

Filter logs starting from this date (inclusive). Format: RFC 3339.

end_date
string <date-time>
Example: end_date=2024-11-15T23:59:59Z

Filter logs until this date (inclusive). Format: RFC 3339.

log_type
string
Enum: "action" "error"
Example: log_type=error

Filter logs by type. Possible values: "action", "error".

subscriber_id
string <uuid>
Example: subscriber_id=aa0f5c91-41ea-4c06-b3a3-af765e2ab07f

Filter logs by subscriber ID.

subscription_id
string <uuid>
Example: subscription_id=aa0f5c91-41ea-4c06-b3a3-af765e2ab07f

Filter logs by subscription ID.

header Parameters
x-pim-client-id
required
string

Client ID of the PIM Connection, App or Custom App for which the Access token has been issued

x-pim-url
required
string <uri>

PIM Url that issued the access token

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}