Request #1

The request is the step that allows the user to define the private API in order to call for the data required by the job. This is followed by the description of the data needed to complete the configuration.

Method determines what kind of function you require the job to perform. Regarding the Stripe use case, we are getting data, so we use a GET method.

The Endpoint is an API URL, here a Stripe event API, is the specific location of accepting requests and returning responses. The endpoint URL required depends on the type of job you are configuring.

Given the method ‘GET’, we are retrieving event data from Stripe, so require the appropriate endpoint. The API endpoint for retrieving a Stripe event is ‘/v1/events/:id’. Check Stripe to find the correct endpoint for other APIs.

Activity on Stripe creates Event objects, and the variable ‘TRIGGER’ extracts the event id from the list of payment events received.

The Header provides authorisation to the bearer of the Stripe API key i.e. whoever holds the secret API. The syntax for the authorisation is in a JSON call format, and as seen in the video, must match the name of your secret. Depending on the API you call, it may be necessary to send data in the body to the API. The Certificate is an additional security feature that provides encryption and authorisation to access an API. Neither are applicable in the Stripe example.

Attestation #1

The attestation outlines the required check on the data being called.

Next, it is time to create the Rules for your call. The Source determines the variable or value of the data you want to check. Meanwhile, the Target defines what to compare your value to for a successful result - here for a confirmation of the payment charge.