Events API

Use the Events API's to create, update, or query the Event Data. This includes specific endpoints to take action (create/update/delete) as well as events related to fact-sheets , rows, fields and labels.

The URL to access the API's is : https://<instance>.cso.coupahost.com/api/events

See Integration Best Practices for more info.

Actions

Elements

These are the elements available for the Events API

Examples

In this example, we queried for a Events API. We did a GET to the URL: 

https://<instance>.cso.coupahost.com/api/events 

Events GET Response

{
		"total": 5,
		"events": [
				{
						"id": "9219595375673293031",
						"market-id": "9219595214580536433",
						"state": "Setup",
						"name": "APC Training Project",
						"description": "For Bids",
						"event-number": 10,
						"settings": {
								"currency": "USD"
						}
				},
				{
						"id": "9219601944812992706",
						"market-id": "9219596879086622384",
						"state": "Setup",
						"name": "API - Data storage",
						"description": "Hamno Testing",
						"event-number": 11,
						"time-zone": "Europe/Stockholm",
						"settings": {
								"currency": "EUR"
						}
				},
				{
						"id": "9219592828238410706",
						"market-id": "9219592396342653837",
						"state": "Active",
						"name": "**IT Hardware and Services 2014",
						"description": "Indirect Services",
						"reference-number": "MC-IN-15/02",
						"event-number": 613,
						"settings": {
								"currency": "GBP"
						}
				},			 
				{
						"id": "9219593444808990596",
						"market-id": "9219593040793966498",
						"state": "Terminated",
						"name": "!*** Test procedures ***! (for backup purposes only)",
						"description": "Tasks to be performed when a new release is about to be launched",
						"event-number": 1602,
						"settings": {
								"currency": "USD"
						}
				},
				{
						"id": "9219594228963465852",
						"market-id": "9219592396342653837",
						"state": "Setup",
						"name": "**Air Freight Tender example - sanitised 9/12/15",
						"description": "Example Air Freight tender",
						"reference-number": "MC-A15-01",
						"event-number": 13,
						"settings": {
								"currency": "SEK"
						}
				}				
	 ]
}

Create/Update/Delete

The following describes how you can use the Coupa API to perform actions on Events.

Create

/api/events

The below payload creates two Events.

Payload: 
{
		"events": [
				{
						"market-id": "9220538753220565329",
						"name": "IT Hardware and Services 2021",
						"description": "direct Services",
						"reference-number": "DEMO-ref1",
						"settings": {
								"currency": "USD"
						}
				},
				{
						"market-id": "9220538753220565329",
						"state": "Setup",
						"name": "Services ONLY",
						"description": "same market with state, timezone and no reference number ",
						"time-zone": "Europe/Stockholm",
						"settings": {
								"currency": "EUR"
						}
				}
		]
}

Response: 201
{
		"result": [
				{
						"type": "api.post.added",
						"description": "2 objects created."
				}
		],
		"added": 2,
		"events": [
				{
						"id": "9220538753252871154"
				},
				{
						"id": "9220538753252871160"
				}
		]
}		

Update

/api/events

The below payload updates a Events. 

To update one or more Event at a time: 
Payload:
{
		"events": [
				{
						"id": "9220538753252871154",
						"state": "Active",
						"name": "IT Hardware and Services 2021-ABC",
						"description": "direct Services - ABC",
						"reference-number": "DEMO-reference"
				},
				{
						"id": "9220538753252871160",
						"name": "Services channges ONLY"
				}
		]
}

Response: 200 OK
{
		"result": [
				{
						"type": "api.put.updated",
						"description": "2 objects updated."
				}
		],
		"updated": 2
}

You can update all fields except event-number and market-id.

Delete

/api/events

The above API can be used to delete more than one event at a time. 

Payload:
{
		"events": [
				{
						"id": "9220538753252871154"
				}
		]
}

Response: 200 OK
{
		"result": [
				{
						"type": "event.deleted.logMsg",
						"description": "The event IT Hardware and Services 2021-ABC was deleted."
				}
		],
		"deleted": 1
}

Successful requests will return HTTP 200 Response. The body of the response will include the created requisition. Unsuccessful requests will return HTTP 400 Bad Request. The body of the response will include validation errors formatted as XML.