The purpose of this API is to provide SAP Concur’s partners the ability to message users through the web and mobile product.

Sample use case: A business traveller starts a travel booking. That user is notified that a visa is required for their trip.

Process Flow

Process flow for notifications

Products and Editions

  • Concur Travel Professional Edition
  • Concur Travel Standard Edition

Scope Usage

Name Description Endpoint
notifications.messages.writeonly Write messages to the notifications platform POST

Dependencies

  • User Profile Service - Get user information using access token (JWT)
  • Events Service - Use access token (JWT) and sessionId to call the Partner Notifications API

Access Token Usage

A Company access token (JWT) is required for this endpoint.

Send a message

The endpoint provides a way for SAP Concur partners to message users and notify them. Partners will provide the identifier of the pre-configured message template, along with the data to apply to the message.

Scopes

notifications.messages.writeonly - Refer to Scope Usage for full details.

Request

URI

Template
https://us.api.concursolutions.com/notifications/v4/messages/{userId}/session
Parameters
Name Type Format Description
userId string - Required The userId of the user to whom the notification should be sent.

Headers

Payload

Response

Status Codes

Headers

Payload

  • HTTP Headers Only
  • Error

Example

Request

POST https://us.api.concursolutions.com/notifications/v4/messages/0E6BD8D8-A020-43C6-BBEC-B67A7021FF1C
/session
Accept: application/json
Authorization: Bearer {JWT}
content-type: application/json
{
   "sessionId": "D5B80C53-A4D2-4949-8462-D41655F246E2",
   "templateId": "template-name",
   "context": {
     "url": "https://www.example.com/foo"
   }
}

Response

HTTP/1.1 200 OK
concur-correlationid: 848618e7-5747-4970-bda7-fc7baf251f88
Content-Type: application/json; charset=utf-8
Date: Thu, 24 Jan 2019 01:31:47 GMT

Schema

Name Type Format Description
sessionId string - Required The unique ID of the session
templateId string - Required The template identifier of the message
context object context Contains additional information required for the template

Context

Name Type Format Description
url string - The context URL to apply to the template. Please contact SAP Concur to add domains to the approved list.

Error

Name Type Format Description
errorId string - The unique ID of the error
errorCode string - The error code
errorMessage string - A message describing the error
errors array error An array of errors. Note: this points to this schema as errors can nest.