API v1 - Webhookpayloadprofile

The Webhookpayloadprofile API provides Webhook payloads data using API call requests. The Webhhokpayloadprofile log will be downloaded in JSON format, where each entry shows a significant action within the Matillion ETL instance. Most actions by users are logged in detail, to allow accountablility for any changes made.

For detailed information on Webhook payloads, read Manage Webhook Payloads.

Webhookpayloadprofile API endpoints will be available for admin users of Matillion ETL.

---

Prerequisites

• To use Matillion ETL API services you require access to the Matillion ETL instance and should 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, read Matillion ETL API - v1.
• Matillion ETL API endpoints require authorization to make any REST API call, so ensure a username and password for the Matillion ETL instance is configured before making any API call.

---

Using the API

Interact with the Webhookpayloadprofile API in a Matillion ETL instance by making a GET, POST, or DELETE call with the form:

<InstanceAddress>/rest/v1/webhookpayloadprofile/<endpoint>

Where:

• <instanceAddress> is the URI of your Matillion ETL instance in the form http://host:port.
• <endpoint> is the name of the API endpoint that accomplishes the task you want to perform. These endpoints are documented in the following sections.

---

List webhookpayloadprofiles

Get a list of webhookpayloadprofiles.

To list the webhookpayloadprofiles, make the following GET call:

<InstanceAddress>/rest/v1/webhookpayloadprofile

A successful GET call to the endpoint will return a JSON response from the server, with the following format:

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

---

Export webhookpayloadprofiles

Export the metadata schema of the webhookpayloadprofile log JSON file available within the Matillion ETL instance.

To export the webhookpayloadprofiles, make the following GET call:

<InstanceAddress>/rest/v1/webhookpayloadprofile/export

A successful GET call to the endpoint will return a JSON response from the server, with the following format:

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

---

Import webhookpayloadprofile

Import one or more webhookpayload profiles from another Matillion ETL instance. This will import a webhookpayloadprofile metadata schema which has been exported as shown in the /export endpoint, above.

If a resource of the same name already exists, you must delete the existing resource before importing the new, or change the name of the imported resource in the POST body.

To import webhookpayloadprofiles, make the following POST call:

<InstanceAddress>/rest/v1/webhookpayloadprofile/import

This endpoint requires a POST body in the following form:

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

A successful POST call to the endpoint will return a JSON response from the server, with the following format:

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

---

Export single webhookpayloadprofile

Export the metadata schema of a single selected webhookpayloadprofile log JSON file available within the Matillion ETL instance.

To export a specific webhookpayloadprofile, make the following GET call:

<InstanceAddress>/rest/v1/webhookpayloadprofile/name/<name>/export

Where <name> is the name of the profile you want to export.

A successful GET call to the endpoint will return a JSON response from the server, with the following format:

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

---

Delete webhookpayloadprofile

Delete a single selected webhookpayloadprofile.

To delete a specific webhookpayloadprofile, make the following DELETE call:

<InstanceAddress>/rest/v1/webhookpayloadprofile/name/<name>/delete

Where <name> is the name of the profile you want to delete.

A successful DELETE call to the endpoint will return a JSON response from the server, with the following format:

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