API docs by Redocly

Event API (1.0)

Download OpenAPI specification:

CharIN e.V.: coordination@charin.global URL: https://charin.global License: Attribution-ShareAlike 4.0 International

Event Notification services API.

PostEndpoint

PostEndpoint

A webhook endpoint must have a url and a list of enabled_events, then webhook endpoint notifies the specified url about events.

header Parameters
OPNC-from-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party that originated this request

OPNC-from-party-id
string

Specifies the ID of the party that originated this request. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS)

OPNC-to-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party to which this request should be addressed.

OPNC-to-party-id
string

Specifies the party ID to which this request should be addressed. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS..)

Request Body schema: application/json

Request body for creating webhook endpoint

apiVersion
string

Optional: Events sent to this endpoint will be generated with this version.

description
string

An optional description of what the webhook is used for.

enabledEvents
required
Array of arrays

We need to add WMI opjects

wmi
Array of arrays

We need to add WMI opjects

metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

status
string

The status of the webhook. It can be enabled or disabled.

url
required
string

The URL of the webhook endpoint.

Responses

Request samples

Content type
application/json
{
  • "description": "This my webhook",
  • "enabledEvents": [
    ],
  • "wmi": [
    ],
  • "status": "enabled",
  • "url": "https://mywebhooks.com/payload"
}

Response samples

Content type
application/json
{
  • "id": "xyzedjds",
  • "apiVersion": "v1",
  • "created": 1623760573,
  • "description": "Test webhook",
  • "enabledEvents": [
    ],
  • "wmi": [
    ],
  • "metadata": { },
  • "status": "enabled",
  • "url": "https://mywebhooks.com/payload",
  • "secret": "secret keyword"
}

Get all endpoints

Returns users all webhook endpoints

header Parameters
OPNC-from-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party that originated this request

OPNC-from-party-id
string

Specifies the ID of the party that originated this request. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS)

OPNC-to-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party to which this request should be addressed.

OPNC-to-party-id
string

Specifies the party ID to which this request should be addressed. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS..)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GetEndpointById

GetEndpointById

Returns webhook endpoint for a given ID

path Parameters
id
required
string

Endpoint ID

header Parameters
OPNC-from-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party that originated this request

OPNC-from-party-id
string

Specifies the ID of the party that originated this request. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS)

OPNC-to-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party to which this request should be addressed.

OPNC-to-party-id
string

Specifies the party ID to which this request should be addressed. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS..)

Responses

Response samples

Content type
application/json
{
  • "id": "xyzedjds",
  • "apiVersion": "v1",
  • "created": 1623760573,
  • "description": "Test webhook",
  • "enabledEvents": [
    ],
  • "metadata": { },
  • "status": "enabled",
  • "url": "https://mywebhooks.com/payload",
  • "secret": "secret keyword",
  • "providerIds": [
    ],
  • "wmis": [
    ],
  • "userRole": "eMSP",
  • "userName": "Test User"
}

UpdateEndpointById

UpdateEndpointById

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

path Parameters
id
required
string

Endpoint ID

header Parameters
OPNC-from-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party that originated this request

OPNC-from-party-id
string

Specifies the ID of the party that originated this request. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS)

OPNC-to-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party to which this request should be addressed.

OPNC-to-party-id
string

Specifies the party ID to which this request should be addressed. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS..)

Request Body schema: application/json
apiVersion
string

Optional: Events sent to this endpoint will be generated with this version.

description
string

An optional description of what the webhook is used for.

enabledEvents
string (EventEnumV1)
Enum: "root.cert.added" "root.cert.expired" "emsp.prov.cert.updated" "emsp.prov.cert.deleted" "emsp.prov.cert.updated.factory.reset" "emsp.contract.delivered.to.oem" "emsp.contract.created.sent.to.oem" "emsp.contract.updated.sent.to.oem" "emsp.contract.deleted.sent.to.oem" "emsp.contract.rejected.by.oem" "emsp.contract.queued.to.oem" "oem.contract.created" "oem.contract.updated" "oem.contract.deleted"
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

status
string

The status of the webhook. It can be enabled or disabled.

url
required
string

The URL of the webhook endpoint.

Responses

Request samples

Content type
application/json
{
  • "apiVersion": "string",
  • "description": "string",
  • "enabledEvents": "root.cert.added",
  • "metadata": { },
  • "status": "string",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "id": "xyzedjds",
  • "apiVersion": "v1",
  • "created": 1623760573,
  • "description": "Test webhook",
  • "enabledEvents": [
    ],
  • "wmi": [
    ],
  • "metadata": { },
  • "status": "enabled",
  • "url": "https://mywebhooks.com/payload"
}

DeleteEndpointById

DeleteEndpointById

Delete an endpoint by ID

path Parameters
id
required
string

Endpoint ID

header Parameters
OPNC-from-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party that originated this request

OPNC-from-party-id
string

Specifies the ID of the party that originated this request. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS)

OPNC-to-party-type
string
Enum: "emsp" "cpo" "oem" "pki" "cps" "pcp" "ccp"

Specifies the type of party to which this request should be addressed.

OPNC-to-party-id
string

Specifies the party ID to which this request should be addressed. The ID format depends on the type of the party (WMI for OEM, ProviderID for EMSP, OperatorID for CPO, SHA-256 fingerprint of Root CA for PKI or CPS..)

Responses