Trigger Properties and Sample Code

In the triggers sections of the adapter definition document, you define the actions or events that can start an integration.

Properties

For each trigger, you must specify the required information, such as the element to use for the request and response and how to process the data. The element to use for the request could be a business object, operation, or another element. The following information is required:

Property	Description
`displayName`	The name of the trigger that shows for an integration developer in Oracle Integration.
`description`	The description for the trigger.
`type`	The type of trigger. Notification signifies that the external source notifies Oracle Integration of the message but does not require a response.
`group`	The name of the group that is defined in the groups section of the adapter definition document.
`execute`	The uniform resource name (URN) that references the flow that implements the trigger. The flows are defined in the flows section of the adapter definition document.
`httpMethod`	The methodology to receive a message from the external source. For example, webhooks use a POST method with a body.
`request`	The schema for an incoming message of this trigger. The request contains `schemaType` and `schema` information. The `schemaType` defines the type of the schema, and supports only the type `application/json`. The `schema` defines the structure of the incoming message, and the structure is exposed to the integration for downstream mapping. It can be an inline schema or a reference to a schema definition in the `schemas` section of the adapter definition document. The request can refer a flow in the `flows` section. The flow implements return of the whole structure that includes both `schemaType` and `schema`. Example code: `"request": { "schemaType": "application/json", "schema": { "$ref": "#/schemas/staticInput" } }, "request": "flow:inputSchemaFlow"`
`webhook`	The third-party notification message structure, which includes headers, parameters,and body.
`headers`	A set of HTTP-header parameters that are defined by name and type.
`parameters`	A set of query parameters defined by name and type, and models the parameters from the webhook request to trigger.
`body`	The HTTP body including schema type and schema. This is similar to the request section.
`subscription`	This object models the ability of the trigger to programmatically subscribe to an event if the external source supports an API that supports subscription. The activation section models the subscription during activation and the deletion of a subscription during the deactivation of an integration. This section consists of filter, register and deregister properties.
`filter`	Enables event filtering at server through registration, or at the client through condition. This property can also filter ping events, and specify response status for client and response filters.
`register`	References a flow that executes an API call on the external service to programmatically register to an event.
`deregister`	References a flow that executes an API call on the external service to programmatically deregister to an event.
`validationRequests`	Identifies validation requests and allows override response behavior for such requests. Validation requests cannot execute integration flows. This property consists of condition, `skipAuthentication` and `response.condition`, jq expression on an incoming request object. It returns either true or false. If true, the validation request is ignored. The output must be a JSON object that represents response status, headers, and body.
`configuration`	Models the configuration option required to configure the trigger. Some triggers may require additional information that users must provide to allow runtime to function. The configuration properties are modeled as user interface widgets with data that is statically defined and fed by flows.

Sample Code

Note:

The sample code provided here is for a webhook trigger.

"triggers": {
   "notificationTypeTrigger": {
     "displayName": "Notification Type Trigger",
     "description": "This trigger detects when an event has been raised.",
     "group": "simpleTrigger",
     "type": "webhook",
     "httpMethod": "POST",
     "request": {
       "schemaType": "application/json",
       "schema": {
         "$ref": "#/schemas/staticInput"
       }
     },
     "webhook": {
       "headers": [
         {
           "name": "http-header-1",
           "type": "string"
         }
       ],
       "parameters": [
         {
           "name": "query-parameter-1",
           "type": "string"
         }
       ],
       "body": {
         "schemaType": "application/json",
         "schema": {
           "$ref": "#/schemas/staticInput"
         }
       }
     }
}