SAP Open Connectors

Coupa Events

Last Modified on 01/19/2021 1:02 pm EST

SAP Open Connectors supports events via polling or webhooks depending on the API provider. For more information about our Events framework, see Events Overview.

Supported Events and Resources

SAP Open Connectors supports polling events for Coupa. After receiving an event, SAP Open Connectors standardizes the payload and sends an event to the configured callback URL of your authenticated connector instance.

You can set up polling for the accounts resource. You can also copy the accounts configuration to poll other resources.

Note: Unless configured for a specific time zone, polling occurs in UTC.

Configure Polling Through the UI

To configure polling through the UI, follow the same steps to authenticate a connector instance, and then turn on events. Select the resources to poll, and then click Create Instance. For more information, see Authenticate a Connector Instance with Events (UI) or the connector-specific authentication topic.

Configure Polling Through API

Use the /instances endpoint to authenticate with Coupa and create a connector instance with polling enabled.

Note: The endpoint returns a connector token upon successful completion. Retain the token for all subsequent requests involving this connector instance.

To authenticate a connector instance with polling:

  1. Construct a JSON body as shown below (see Parameters):

    {
  "element": {
    "key": "coupa"
  },
  "name": "INSTANCE_NAME",
  "configuration": {
    "event.poller.configuration": {
      "accounts": {
        "url": "/hubs/businessspendmanagement/accounts?where=updated_at>='${date:yyyy-MM-dd'T'HH:mm:ssXXX}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "updated-at",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "updatedDateTimezone": "PST",
          "createdDateField": "created-at",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "createdDateTimezone": "PST"
        }
      },
      "users": {
        "url": "/hubs/businessspendmanagement/users?where=updated_at>='${date:yyyy-MM-dd'T'HH:mm:ssXXX}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "updated-at",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "updatedDateTimezone": "PST",
          "createdDateField": "created-at",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "createdDateTimezone": "PST"
        }
      },
      "orders": {
        "url": "/hubs/businessspendmanagement/orders?where=updated_at>='${date:yyyy-MM-dd'T'HH:mm:ssXXX}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "updated-at",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "updatedDateTimezone": "PST",
          "createdDateField": "created-at",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "createdDateTimezone": "PST"
        }
      },
      "invoices": {
        "url": "/hubs/businessspendmanagement/invoices?where=updated_at>='${date:yyyy-MM-dd'T'HH:mm:ssXXX}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "updated-at",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "updatedDateTimezone": "PST",
          "createdDateField": "created-at",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "createdDateTimezone": "PST"
        }
      },
      "inventoryTransactions": {
        "url": "/hubs/businessspendmanagement/inventory-transactions?where=updated_at>='${date:yyyy-MM-dd'T'HH:mm:ssXXX}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "updated-at",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "updatedDateTimezone": "PST",
          "createdDateField": "created-at",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "createdDateTimezone": "PST"
        }
      },
      "purchaseOrders": {
        "url": "/hubs/businessspendmanagement/purchase-orders?where=updated_at>='${date:yyyy-MM-dd'T'HH:mm:ssXXX}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "updated-at",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "updatedDateTimezone": "PST",
          "createdDateField": "created-at",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "createdDateTimezone": "PST"
        }
      },
      "products": {
        "url": "/hubs/businessspendmanagement/products?where=updated_at>='${date:yyyy-MM-dd'T'HH:mm:ssXXX}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "updated-at",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "updatedDateTimezone": "PST",
          "createdDateField": "created-at",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "createdDateTimezone": "PST"
        }
      },
      "contracts": {
        "url": "/hubs/businessspendmanagement/contracts?where=updated_at>='${date:yyyy-MM-dd'T'HH:mm:ssXXX}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "updated-at",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "updatedDateTimezone": "PST",
          "createdDateField": "created-at",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "createdDateTimezone": "PST"
        }
      },
      "suppliers": {
        "url": "/hubs/businessspendmanagement/suppliers?where=updated_at>='${date:yyyy-MM-dd'T'HH:mm:ssXXX}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "updated-at",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "updatedDateTimezone": "PST",
          "createdDateField": "created-at",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "createdDateTimezone": "PST"
        }
      },
      "forms": {
        "url": "/hubs/businessspendmanagement/forms?where=updated_at>='${date:yyyy-MM-dd'T'HH:mm:ssXXX}'",
        "idField": "",
        "datesConfiguration": {
          "updatedDateField": "updated-at",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "updatedDateTimezone": "PST",
          "createdDateField": "created-at",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "createdDateTimezone": "PST"
        }
      }
    },
    "event.poller.refresh_interval": "15",
    "event.notification.enabled": true,
    "event.vendor.type": "polling",
    "filter.response.nulls": "true",
    "api.key": "xxxxxxxxxxx",
    "siteAddress": "xxxxxxxxxxxxxx"
  }
}
  2. Call the following, including the JSON body you constructed in the previous step:
    POST /instances
    Note: Make sure that you include the User and Organization keys in the header. For more information, see Authorization Headers, Organization Secret, and User Secret.
  3. Locate the token and id in the response and save them for all future requests using the connector instance.

Example JSON with Polling

instance JSON with polling events enabled:

{
  "element": {
    "key": "coupa"
  },
  "name": "INSTANCE_NAME",
  "configuration": {
    "event.poller.configuration": {
      "accounts": {
        "url": "/hubs/businessspendmanagement/accounts?where=updated_at>='${date:yyyy-MM-dd'T'HH:mm:ssXXX}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "updated-at",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "updatedDateTimezone": "PST",
          "createdDateField": "created-at",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "createdDateTimezone": "PST"
        }
      },
      "users": {
        "url": "/hubs/businessspendmanagement/users?where=updated_at>='${date:yyyy-MM-dd'T'HH:mm:ssXXX}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "updated-at",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "updatedDateTimezone": "PST",
          "createdDateField": "created-at",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "createdDateTimezone": "PST"
        }
      },
      "orders": {
        "url": "/hubs/businessspendmanagement/orders?where=updated_at>='${date:yyyy-MM-dd'T'HH:mm:ssXXX}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "updated-at",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "updatedDateTimezone": "PST",
          "createdDateField": "created-at",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "createdDateTimezone": "PST"
        }
      },
      "invoices": {
        "url": "/hubs/businessspendmanagement/invoices?where=updated_at>='${date:yyyy-MM-dd'T'HH:mm:ssXXX}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "updated-at",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "updatedDateTimezone": "PST",
          "createdDateField": "created-at",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "createdDateTimezone": "PST"
        }
      },
      "inventoryTransactions": {
        "url": "/hubs/businessspendmanagement/inventory-transactions?where=updated_at>='${date:yyyy-MM-dd'T'HH:mm:ssXXX}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "updated-at",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "updatedDateTimezone": "PST",
          "createdDateField": "created-at",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "createdDateTimezone": "PST"
        }
      },
      "purchaseOrders": {
        "url": "/hubs/businessspendmanagement/purchase-orders?where=updated_at>='${date:yyyy-MM-dd'T'HH:mm:ssXXX}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "updated-at",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "updatedDateTimezone": "PST",
          "createdDateField": "created-at",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "createdDateTimezone": "PST"
        }
      },
      "products": {
        "url": "/hubs/businessspendmanagement/products?where=updated_at>='${date:yyyy-MM-dd'T'HH:mm:ssXXX}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "updated-at",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "updatedDateTimezone": "PST",
          "createdDateField": "created-at",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "createdDateTimezone": "PST"
        }
      },
      "contracts": {
        "url": "/hubs/businessspendmanagement/contracts?where=updated_at>='${date:yyyy-MM-dd'T'HH:mm:ssXXX}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "updated-at",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "updatedDateTimezone": "PST",
          "createdDateField": "created-at",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "createdDateTimezone": "PST"
        }
      },
      "suppliers": {
        "url": "/hubs/businessspendmanagement/suppliers?where=updated_at>='${date:yyyy-MM-dd'T'HH:mm:ssXXX}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "updated-at",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "updatedDateTimezone": "PST",
          "createdDateField": "created-at",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "createdDateTimezone": "PST"
        }
      },
      "forms": {
        "url": "/hubs/businessspendmanagement/forms?where=updated_at>='${date:yyyy-MM-dd'T'HH:mm:ssXXX}'",
        "idField": "",
        "datesConfiguration": {
          "updatedDateField": "updated-at",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "updatedDateTimezone": "PST",
          "createdDateField": "created-at",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX",
          "createdDateTimezone": "PST"
        }
      }
    },
    "event.poller.refresh_interval": "15",
    "event.notification.enabled": true,
    "event.vendor.type": "polling",
    "filter.response.nulls": "true",
    "api.key": "xxxxxxxxxxx",
    "siteAddress": "xxxxxxxxxxxxxx"
  }
}

Parameters

API parameters not shown in SAP Open Connectors are in code formatting.

ParameterDescriptionData Type
keyThe connector key.
coupa		string
Name
name		The name for the connector instance created during authentication.Body
api.keyThe Coupa api key.string
siteAddressThe Coupa site addressstring
Events Enabled
event.notification.enabled		Optional. Identifies that events are enabled for the connector instance.
Default: false.		boolean
Event Notification Callback URL
event.notification.callback.url		The URL where you want SAP Open Connectors to send the events.string
Event poller refresh interval (mins)
event.poller.refresh_interval		A number in minutes to identify how often the poller should check for changes.number
Configure Polling
event.poller.configuration		Optional*. Configuration parameters for polling.JSON object
URL
url		The url to query for updates to the resource.String
ID Field
idField		The field in the resource that is used to uniquely identify it.String
Advanced Filtering
datesConfiguration		Configuration parameters for dates in pollingJSON Object
Updated Date Field
updatedDateField		The field that identifies an updated object.String
Updated Date Format
updatedDateFormat		The date format of the field that identifies an updated object.String
Created Date Field
createdDateField		The field that identifies a created object.String
Created Date Format
createdDateFormat		The date format of the field that identifies a created object.String
tagsOptional. User-defined tags to further identify the instance.string

Related Information

  • None
User Icon

Thank you! Your comment has been submitted for approval.