API v1 - Webhookpayloadprofile

Overview

This is a guide to providing details on the Webhookpayloadprofile API services offered by Matillion ETL. These services provides the Webhook payloads data using the API call request.

Webhookpayloadprofile API provides the "resource" data ("Resources" refers to the information returned by an API). These resources usually have various endpoints which are combined with multiple HTTP methods for each endpoint. Audit API endpoint uses only GET method to retrive the data and export the log data within the Matillion ETL instance.

Important Information

• Users responsible for experimenting with Matillion ETL API services require access to the Matillion ETL instance and ought to know how to make REST API calls either employing a REST API GUI client such as Postman or employing a command-line interface like cURL.
• For more information about accessing the Matillion API, and general information on the Matillion API platform before using the API, please refer to Matillion ETL API - v1.
• Matillion ETL API endpoints require authorisation to make any REST API call, so ensure a username and password for the Matillion ETL instance is configured before making any API call.
• Webhookpayloadprofile API endpoint will be available for the admin users of Matillion ETL.
• For detailed information on the Webhook Post component, read Manage Webhook Payloads.

Webhookpayloadprofile API Endpoints

API Base URL

http(s)://<InstanceAddress>/rest/v1/<webhookpayloadprofile>

API Endpoints and Function

Webhookpayloadprofile API is available on standard REST-based APIs that uses HTTP or HTTPS request to GET and POST data. The Webhookpayloadprofile API service is accessed through the Uniform Resource Identifier (URI). All following references in this document will assume the API Base URL has been specified. The available API endpoints are listed below:

Webhook Payload Profile Endpoint (/webhookpayloadprofile)

API Base URL

http(s)://<InstanceAddress>/rest/v1/<webhookpayloadprofile>

API Endpoints and Function

Method	Path	URI	Function
GET	/webhookpayloadprofile	http://<instanceaddress>/rest/v1/webhookpayloadprofile	Export the list of webhookpayload profile.
GET	/export	http://<instanceaddress>/rest/v1/webhookpayloadprofile/export	Export all webhookpayload profiles.
POST	/import	http://<InstanceAddress>/rest/v1/webhookpayloadprofile/import WITH POST DATA	Import one or more webhookpayload profile.
GET	/name/<webhook>/export	http://<InstanceAddress>/rest/v1/webhookpayloadprofile/name/<webhook>/export	Export the selected webhookpayload profile.
DELETE	/name/<webhook>/delete	http://<InstanceAddress>/rest/v1/webhookpayloadprofile/name/<webhook>/delete	Delete the selected webhookpayload profile via DELETE request.

---

URL Parameters and Description

Below is the list of endpoint parameters and their brief description:

Parameters Name	Description
<InstanceAddress>	This is the server IP address or domain name.
<webhookpayloadprofile>	The webhookpayload profile witin the instance.
<export>	This property export the webhookpayload profile data in the instance.
<import>	This allows the API to import the webhookpayload profile from another Matillion ETL instance.
<delete>	This allows the API to delete selected webhookpayload profile file.

---

Endpoints and Server Response

This chapter describes the Webhookpayloadprofile API endpoints and examples. These APIs offers REST-based web service, offering ease of use and a flexible choice of programming language. These APIs can be used to access and analyse the users data, export and import within the Matillion ETL instance.

All the APIs listed in this chapter are available to use with GET, POST and, DELETE method to retrieve or export the webhookpayload profile data within the Matillion ETL instance. The detailed description of each endpoint and associated methods is discussed below.

GET/webhookpayloadprofile

In the example below, we will be retrieving the list of webhookpayload profiles created in Matillion ETL instance.

• Base URL

  http://<InstanceAddress>/rest/v1/webhookpayloadprofile

• Server Response

      [
      "Payload_test.json",
      "Docs_Payload_test.json"
  ]

---

GET/export

This is a Get request API call, which will export the metadata schema of webhookpayloadprofile log JSON file available within the Matillion ETL instance by adding /export endpoint in the base URI.

• Base URL

  http://<InstanceAddress>/rest/v1/webhookpayloadprofile/export

• Server Response

  {
      "objects": [
          {
              "name": "Payload_test.json",
              "content": "{example_content}",
              "type": "JSON"
          },
          {
              "name": "Payload_test2.json",
              "content": "{example_content}",
              "type": "JSON"
          }
      ],
      "version": "Built",
      "environment": "redshift"
  }

---




POST/import

This will import the webhookpayload profile metadata schema which is exported as shown in the above example using /import endpoint. If a resource of the same name already exists, you must delete the existing resource before importing the new or you can change the name of the imported resource (Payload-Imported)in the POST BODY. This API call is a POST method API call as we will have to attach the resource data, in the body as a JSON file to import into the Matillion ETL instance.

• Base URL

      http://<InstanceAddress>/rest/v1/webhookpayloadprofile/import

• POST Body (JSON)

  {
      "objects": [
          {
              "name": "Payload_import.json",
              "content": "{example_content},
              "type" : "JSON"
             ],
      "version": "Built",
      "environment": "redshift"
  }

• Server Response

  {
      "name": "Webhooks",
      "statusList": [
          {
              "success": true,
              "name": "Payload_import.json"
          }
      ],
      "success": true
  }
     

---

GET/name/<webhook>/export

This is a Get request API call, which will export the metadata schema of the selected webhookpayloadprofile log JSON file available within the Matillion ETL instance by adding /export endpoint in the base URI.

• Base URL

  http://<InstanceAddress>/rest/v1/webhookpayloadprofile/name/<webhook>/export

• Server Response

  {
      "objects": [
          {
              "name": "Payload_test.json",
              "content": "{example_content}",
              "type": "JSON"
          },
              ],
      "version": "Built",
      "environment": "redshift"
  }

---

DELETE/name/<webhook>/delete

This will delete the selected webhookpayload profile metadata schema using /delete endpoint.

• Base URL

      http://<InstanceAddress>/rest/v1/webhookpayloadprofile/name/<webhook>/delete

• Server Response

  {
      "success": true,
      "msg": "Successfully deleted webhook [default]",
      "id": -1
    }
     

---

Please Note

The Webhhokpayloadprofile log will be downloaded as JSON where each entry shows a significant action within a Matillion Instance. Most actions by users are logged here in detail such that they are accountable for any changes made.

---