Event Subscription Service v4
The Event Subscription Service (ESS) implements the Publish/Subscribe pattern using principles of Event Driven Architecture in the SAP Concur platform. It allows clients and partners to be notified through web services when certain actions take place in connected companies. When the business/system event occurs ESS sends that event to the configured endpoint with relevant information.
- Event - a state of a business/system object or entity. Always has an
EventTypethat represents a type of entity change or specific state in a workflow. Example: Report Created, Report Submitted, etc.
- Topic - a stream of events of business/system object or entity. Example:
- Subscription - a topic consumer. Each subscription has a topic it is subscribed to.
- Webhook - an ESS application that uses a subscription model and delivers events to the endpoint.
In order to begin receiving events, you must first subscribe to the relevant topic(s) for your application. To subscribe to an event, you must work with your relevant SAP Concur technical contact; for partners, please work with your technical enablement contact. For customers, your web services consultant will subscribe on your behalf to the relevant topic(s).
There are two levels of scopes required for creating subscription.
||Access to ESS API||GET, POST, PUT, DELETE|
||Access to specific topic (events)||GET, POST, PUT, DELETE|
- If application has only the
events.topic.readscope an empty list of topics will always be returned.
ESS requires a caller to have a proper JWT and scopes, for more details please see the Scopes documentation. A caller must have the following types of scopes:
- The ESS API level scope
events.topic.readis required to be able to access ESS API.
- A resource level scope, for example
expense.request.readis required to be able to access the
expense.requesttopic and to be able to create subscriptions to that topic.
All required scopes can be requested for a caller application by Partner Enablement team.
It is important to remember that ESS doesn’t have an API that you can call for events, ESS delivers events to your endpoint.
- It uses an outbound callout where the SAP Concur offering calls a public facing URL provided by client or partner, which is a web server hosted by the third-party developer or client.
- The application endpoint can also use the related web services to retrieve or send SAP Concur data. For example, an event may be generated when a request for travel is submitted. The application endpoint may then leverage data from the event, such as the request ID, to retrieve the relevant travel request record from the published Request APIs.
ESS guarantees at least once event delivery. This is accomplished through the retry posting the event payload to the subscribers’ endpoint until the response indicates successful receipt. The expected maximum acknowledgment time for a request to the subscribers’ endpoint is 30 seconds. The service will attempt posting to the endpoint and then hold and retry until the subscriber endpoint responds with delivered or not accepted. The service will retry at least 3 days and skip to the next event after unsuccessful delivery. We suggest that the subscriber consider following:
- Endpoint response time requirements depend on the topic throughput. Please review the topic documentation for throughput.
- It is highly recommended to implement a queue behind the subscriber’ endpoint in order to keep response time as low as possible.
- The subscriber must maintain a reasonable uptime to support the requirements of the integration scenario.
- Your HTTPS server endpoint must be accessible from the public web with a non-self-signed certificate. The certificate should be signed by a known Certificate Authority and should be reachable through DNS.
There are several ways that you can be sure that your endpoint being accessed by our service.
- We will always use the same client x509 certificate. The common name is
CN=webhook.api.concursolutions.com,O=Concur Technologies\, Inc.,L=Bellevue,ST=Washington,C=USand the certificate serial number is
- We will always use a digital signature, supplied in the request header
Concur-Signature. If you decide to use this authentication method you will need our Public Key.
-----BEGIN PUBLIC KEY----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxS1LsXrEWEEMPooLHa4r osCAnmkO3HaBAk0YcsDMR6hQeuQNLqRWP65TpbfTbKWmZ22Hzep3Ekhs1qvSZgI+ iq/bnVeDhkcD+LqVQGP+7fyE0E0bO96FOzMmtbRet4wAiiE9+uw5GmZfg+fRG3yI y2N5u5p7VHJ1RwNugrIUQjhrLvZc+lhqR/aKTxQCQ5CGAgLZIcr3FIWCWrSBMK3d Wy3KI+qe3ZX0STrCCNxl2UFnuuAa2RZZ2j4QtWHlNkyK+UEup+cGkvpc1XrT7anL HlbTP6jE7MqB5sJ9r2EEzrJzJZjD13UqlzvI61tTC8SKpuk5AEaSsUV7RKlKUCjB 8wIDAQAB -----END PUBLIC KEY-----
The Event Subscription service has the following characteristics from the subscriber perspective:
- Requests will come from
- Connection will always be established using a client x509 certificate.
- Requests will always have a digital signature.
- Requests will be re-tried when the subscriber responds with HTTP Response Code(s): 5xx, 401, 403, or 429.
- Requests will not be re-tried when subscriber responds with HTTP Response Code(s):
- 2xx – Indicates successful receipt of the event.
- 4xx – Indicates posted event is unexpected or incorrectly formatted.
- Request will be retried until delivery OR event retention period expiration.
- Event retention period is 72 hours from the time of event being published.
- Events are not archived, but all of the event delivery attempts/responses are logged and retained for 30 days.