Amplify Central Integration Webhooks – Basics

Amplify Central Integration Webhooks - Basics

Introduction

Integration webhooks provide an “event” based means to monitor activity in Amplify Central in an external application that you create. Coupled with Amplify Central platform APIs, integration webhooks are a powerful tool for integrating Amplify Central into the rest of your API first toolchain.

Integration webhooks are different than subscription webhooks, which are added to an environment and pertain to API subscription requests for catalog items from the environment. Integration webhooks can apply to one or more environments and pertain to many resources across those environments.

For example, you can configure an integration webhook to trigger whenever an API Service is added to one or more environments or when an attribute is added to the environment. You use Amplify Central APIs or the Amplify CLI to configure integration webhooks. In this blog post, we’ll use APIs.

Refer to the online docs: Set up integrations through Webhooks for all the technical details around integration webhooks.

Let’s walk through an example of how to set up and test an integration webhook.

Note: Refer to this blog post to learn how to make API calls to Amplify Central.

Create an Integration Webhook

Integration Webhooks can be configured using the Axway CLI or via API calls. In this blog post series, I’ll be using APIs.

In the following API calls, {{apiCentralUrl}} is the Amplify Central base address for API calls. By default, it is https://apicentral.axway.com but could be different based on your region. Also, in all the API calls below, you need to pass in the following headers as described here:

'Authorization': `Bearer <YOUR ACCESS_TOKEN>`,
'Content-Type': 'application/json'

Create the Integration

Use the following API call to create an integration called myintegration.

POST {{apiCentralUrl}}/apis/management/v1alpha1/integrations

Body:

{
    "name": "myintegration",
    "title": "Integration",
    "tags": [
        "cloud"
    ],
    "attributes": {},
    "spec": {
        "description": "This is an integration."
    }
}

Create a Secret

We can use a secret so that the app that receives the webhook can be sure it is coming from a trusted source. The secret will be sent as an Authorization header.

POST {{apiCentralUrl}}/apis/management/v1alpha1/integrations/myintegration/secrets

Body:

{
    "name": "webhooksecret",
    "title": "API Key Secret for Webhook reference",
    "tags": [
        "saas",
        "axway"
    ],
    "attributes": {
    },
    "spec": {
        "data": {
            "apikey": "Password123"
        }
    }
}

Note that in this example, my Integration named myintegration is part of the API path (/apis/management/v1alpha1/integrations/{{IntegrationName}}/webhooks). This is the name given to the Integration in the prior API call.

Note that you can see Password123 in the webhook Authorization header when triggered as follows:

Host: en9c5wvi5vta4.x.pipedream.net
X-Amzn-Trace-Id: Root=1-6065c447-3c5b35a840f6e43e078b9c79
Content-Length: 1295
Authorization: Password123
X-Axway-Event-Id: 170d3081-9c48-459e-82e2-f37f5e3f1d74
User-Agent: amplify-central
Accept: application/json
Content-Type: application/json

Create a Webhook

Let’s create a webhook in this integration. The webhook will make a POST to the url specified in the body: https://en9c5wvi5vta4.x.pipedream.net. It will send the webhook secret as an Authorization Header, Authorization: Password123, as described above.

POST /apis/management/v1alpha1/integrations/myintegration/webhooks

Body:

{
    "name": "webhook",
    "title": "Webhook to invoke requestbin.com",
    "tags": [
        "prod",
        "saas",
        "axway"
    ],
    "attributes": {
        "release": "1.0.0"
    },
    "spec": {
        "enabled": true,
        "url": "https://en9c5wvi5vta4.x.pipedream.net",
        "auth": {
            "secret": {
                "name": "webhooksecret",
                "key": "apikey"
            }
        }
    }
}

Create a Resource Hook

The resource hook will tell the integration when to invoke the webhook. In this case, we will generate a webhook call whenever there is any triggerable event in the environment, manualenv. This is derived from the online docs sample resource hook payload called “Monitor changes in a specific environment and on all its resources:”

POST /apis/management/v1alpha1/integrations/myintegration/resourcehooks/

Body:

{
   "group": "management",
   "apiVersion": "v1alpha1",
   "kind": "ResourceHook",
   "name": "environments-hook",
   "title": "Monitor Environment manualenv and all its resources",
   "metadata": {
      "scope": {
         "kind": "Integration",
         "name": "myintegration"
      }
   },
   "spec": {
      "triggers": [
         {
            "group": "management",
            "kind": "Environment",
            "name": "manualenv",
            "type": [
               "created",
               "updated",
               "deleted"
            ]
         },
         {
            "group": "management",
            "kind": "*",
            "name": "*",
            "type": [
               "created",
               "updated",
               "deleted"
            ],
            "scope": {
               "kind": "Environment",
               "name": "manualenv"
            }
         }
      ],
      "webhooks": [
         "webhook"
      ]
   }
}

Note that the resource hook is set up with two triggers. One is for any modification to the environment itself and another trigger on any resource modification in the environment: “manualenv” as signified by the * wildcard for “kind” and “name”

Test the Webhook

I manually added an API Service to the manualenv environment but did not publish it to the Unified Catalog as shown below:

and I received three webhook calls in my requestbin:

Each one is below.

The first is related to the APIService resource being created:

{
    "id": "b3ebb1a2-a6a2-49e2-a385-933d74cdd064",
    "time": "2021-04-02T12:17:40.718+0000",
    "version": "v1",
    "product": "AmplifyCentral",
    "correlationId": "0c4d5905-d3d9-4a62-859f-0bbda61f145c",
    "organization": {
        "id": "100000142"
    },
    "type": "ResourceCreated",
    "payload": {
        "finalizers": [],
        "metadata": {
            "id": "8a2e83617870fa00017892848025118c",
            "audit": {
                "createTimestamp": "2021-04-02T12:17:40.389+0000",
                "createUserId": "789f8247a10c466f36894f0f3cfdce19",
                "modifyTimestamp": "2021-04-02T12:17:40.389+0000",
                "modifyUserId": "789f8247a10c466f36894f0f3cfdce19"
            },
            "scope": {
                "id": "8a2e96e67870fa1c01788e7e19d30ed0",
                "kind": "Environment",
                "name": "manualenv",
                "selfLink": "/management/v1alpha1/environments/manualenv"
            },
            "resourceVersion": "286973",
            "references": [],
            "selfLink": "/management/v1alpha1/environments/manualenv/apiservices/comprehend"
        },
        "apiVersion": "v1alpha1",
        "kind": "APIService",
        "name": "comprehend",
        "attributes": {},
        "title": "comprehend",
        "spec": {},
        "group": "management",
        "tags": []
    }
}

The second is related to the APIServiceRevision resource being created:

{
    "id": "86dab2e4-ed6c-41bc-850b-6631325ccea6",
    "time": "2021-04-02T12:17:40.951+0000",
    "version": "v1",
    "product": "AmplifyCentral",
    "correlationId": "41597cc1-ef32-4f53-aeff-4a1a71ea4122",
    "organization": {
        "id": "100000142"
    },
    "type": "ResourceCreated",
    "payload": {
        "finalizers": [],
        "metadata": {
            "id": "8a2e83617870fa00017892848124118d",
            "audit": {
                "createTimestamp": "2021-04-02T12:17:40.644+0000",
                "createUserId": "789f8247a10c466f36894f0f3cfdce19",
                "modifyTimestamp": "2021-04-02T12:17:40.644+0000",
                "modifyUserId": "789f8247a10c466f36894f0f3cfdce19"
            },
            "scope": {
                "id": "8a2e96e67870fa1c01788e7e19d30ed0",
                "kind": "Environment",
                "name": "manualenv",
                "selfLink": "/management/v1alpha1/environments/manualenv"
            },
            "resourceVersion": "286974",
            "references": [
                {
                    "id": "8a2e83617870fa00017892848025118c",
                    "kind": "APIService",
                    "name": "comprehend",
                    "type": "hard",
                    "selfLink": "/management/v1alpha1/environments/manualenv/apiservices/comprehend"
                }
            ],
            "selfLink": "/management/v1alpha1/environments/manualenv/apiservicerevisions/comprehend-version"
        },
        "apiVersion": "v1alpha1",
        "kind": "APIServiceRevision",
        "name": "comprehend-version",
        "attributes": {},
        "title": "comprehend-version",
        "spec": {
            "apiService": "comprehend",
            "definition": {
                "type": "oas2",
                "value": "{
  "swagger": "2.0",
  "info": {
    "title": "comprehend",
    "description": "An API Builder service",
    "version": "1.0.0"
  },
  "host": "6f30762e7f581339e05dc1a62bb934012d3fdff0.cloudapp-enterprise.appcelerator.com",
  "basePath": "/comprehend",
  "security": [{
    "apikey": []
  }],
  "paths": {
    "/detectdominantlanguage": {
      "get": {
        "responses": {
          "200": {
            "description": "Languages",
            "schema": {
              "type": "object",
              "required": ["success", "request-id", "key"],
              "properties": {
                "code": {
                  "type": "integer",
                  "format": "int32"
                },
                "success": {
                  "type": "boolean"
                },
                "request-id": {
                  "type": "string"
                },
                "message": {
                  "type": "string"
                },
                "url": {
                  "type": "string"
                },
                "key": {
                  "type": "string",
                  "enum": ["language"]
                },
                "language": {
                  "$ref": "#/definitions/schema.comprehend_languages"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {}
          }
        },
        "description": "Determines the dominant language of the input text passed in the Text query parameter (e.g. \"Les API sont cool\" returns \"fr\" for French)",
        "operationId": "findDetectdominantlanguage",
        "parameters": [{
          "name": "Text",
          "in": "query",
          "description": "A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters with a minimum length of 1.",
          "type": "string"
        }],
        "produces": ["application/json", "application/xml", "text/yaml", "text/csv", "text/plain"],
        "tags": ["detectdominantlanguage"]
      }
    },
    "/detectentities": {
      "get": {
        "responses": {
          "200": {
            "description": "Entities",
            "schema": {
              "type": "object",
              "required": ["success", "request-id", "key"],
              "properties": {
                "code": {
                  "type": "integer",
                  "format": "int32"
                },
                "success": {
                  "type": "boolean"
                },
                "request-id": {
                  "type": "string"
                },
                "message": {
                  "type": "string"
                },
                "url": {
                  "type": "string"
                },
                "key": {
                  "type": "string",
                  "enum": ["entity"]
                },
                "entity": {
                  "$ref": "#/definitions/schema.comprehend_entities"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {}
          }
        },
        "description": "Detect the entities of the text passed in the Text query parameter (e.g. \"John moved to 1313 Mockingbird Lane in 2012\" returns PERSON, LOCATION and DATE)",
        "operationId": "findDetectentities",
        "parameters": [{
          "name": "Text",
          "in": "query",
          "description": "A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters with a minimum length of 1.",
          "type": "string"
        }, {
          "name": "LanguageCode",
          "in": "query",
          "description": "The language of the input text:  en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW",
          "type": "string"
        }],
        "produces": ["application/json", "application/xml", "text/yaml", "text/csv", "text/plain"],
        "tags": ["detectentities"]
      }
    },
    "/detectpiientities": {
      "get": {
        "responses": {
          "200": {
            "description": "Entities",
            "schema": {
              "type": "object",
              "required": ["success", "request-id", "key"],
              "properties": {
                "code": {
                  "type": "integer",
                  "format": "int32"
                },
                "success": {
                  "type": "boolean"
                },
                "request-id": {
                  "type": "string"
                },
                "message": {
                  "type": "string"
                },
                "url": {
                  "type": "string"
                },
                "key": {
                  "type": "string",
                  "enum": ["piientity"]
                },
                "piientity": {
                  "$ref": "#/definitions/schema.comprehend_piientities"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {}
          }
        },
        "description": "Detect PII (Personally Identifiable Information) entities of the text passed in the Text query parameter (e.g. \"Hello Paulo Santos. The latest statement for your credit card account 1111-0000-1111-0000 was mailed to 123 Any Street, Seattle, WA 98109\" returns NAME, CREDIT_DEBIT_NUMBER and ADDRESS)",
        "operationId": "findDetectpiientities",
        "parameters": [{
          "name": "Text",
          "in": "query",
          "description": "A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters with a minimum length of 1.",
          "type": "string"
        }, {
          "name": "LanguageCode",
          "in": "query",
          "description": "The language of the input text:  en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW",
          "type": "string"
        }],
        "produces": ["application/json", "application/xml", "text/yaml", "text/csv", "text/plain"],
        "tags": ["detectpiientities"]
      }
    },
    "/detectsentiment": {
      "get": {
        "responses": {
          "200": {
            "description": "Sentiment",
            "schema": {
              "type": "object",
              "required": ["success", "request-id", "key"],
              "properties": {
                "code": {
                  "type": "integer",
                  "format": "int32"
                },
                "success": {
                  "type": "boolean"
                },
                "request-id": {
                  "type": "string"
                },
                "message": {
                  "type": "string"
                },
                "url": {
                  "type": "string"
                },
                "key": {
                  "type": "string",
                  "enum": ["sentiment"]
                },
                "sentiment": {
                  "$ref": "#/definitions/schema.comprehend_sentiment"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {}
          }
        },
        "description": "Detect the sentiment of the text passed in the Text query parameter (e.g. \"APIs are cool\" returns POSITIVE with a Postive Sentiment Score of 0.8644070625305176)",
        "operationId": "findDetectsentiment",
        "parameters": [{
          "name": "Text",
          "in": "query",
          "description": "A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters with a minimum length of 1.",
          "type": "string"
        }, {
          "name": "LanguageCode",
          "in": "query",
          "description": "The language of the input text:  en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW",
          "type": "string"
        }],
        "produces": ["application/json", "application/xml", "text/yaml", "text/csv", "text/plain"],
        "tags": ["detectsentiment"]
      }
    }
  },
  "definitions": {
    "ResponseModel": {
      "type": "object",
      "required": ["success", "request-id"],
      "properties": {
        "code": {
          "type": "integer",
          "format": "int32"
        },
        "success": {
          "type": "boolean"
        },
        "request-id": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "url": {
          "type": "string"
        }
      }
    },
    "ErrorModel": {
      "type": "object",
      "required": ["message", "code", "success", "request-id"],
      "properties": {
        "code": {
          "type": "integer",
          "format": "int32"
        },
        "success": {
          "type": "boolean",
          "default": false
        },
        "request-id": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "url": {
          "type": "string"
        }
      }
    },
    "schema.comprehend_languages": {
      "type": "object",
      "properties": {
        "Languages": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "LanguageCode": {
                "type": "string"
              },
              "Score": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "schema.comprehend_entities": {
      "type": "object",
      "properties": {
        "Entities": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "Score": {
                "type": "number"
              },
              "Type": {
                "type": "string"
              },
              "Text": {
                "type": "string"
              },
              "BeginOffset": {
                "type": "integer"
              },
              "EndOffset": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "schema.comprehend_piientities": {
      "type": "object",
      "properties": {
        "Entities": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "Score": {
                "type": "number"
              },
              "Type": {
                "type": "string"
              },
              "BeginOffset": {
                "type": "integer"
              },
              "EndOffset": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "schema.comprehend_sentiment": {
      "type": "object",
      "allOf": [{
        "$ref": "#/definitions/sentiment-ex"
      }, {
        "type": "object",
        "properties": {
          "SentimentScore": {
            "$ref": "#/definitions/SentimentScore"
          }
        }
      }]
    },
    "sentiment-ex": {
      "type": "object",
      "properties": {
        "Sentiment": {
          "type": "string"
        }
      }
    },
    "SentimentScore": {
      "type": "object",
      "properties": {
        "Positive": {
          "type": "number"
        },
        "Negative": {
          "type": "number"
        },
        "Neutral": {
          "type": "number"
        },
        "Mixed": {
          "type": "number"
        }
      },
      "additionalProperties": false
    }
  },
  "securityDefinitions": {
    "apikey": {
      "type": "apiKey",
      "name": "apikey",
      "in": "header",
      "description": "Require authorized access to API"
    }
  },
  "schemes": ["http"]
}
"
            }
        },
        "group": "management",
        "tags": []
    }
}

Note the Base64 encoded OAS2 Swagger definition for the API I imported above.

The third is related to the APIServiceInstance resource being created:

{
    "id": "6ed03d54-448e-4306-abc5-3c0498d2169a",
    "time": "2021-04-02T12:17:41.273+0000",
    "version": "v1",
    "product": "AmplifyCentral",
    "correlationId": "22f13510-20f5-4e77-bbb5-7f8b2f3c674d",
    "organization": {
        "id": "100000142"
    },
    "type": "ResourceCreated",
    "payload": {
        "finalizers": [],
        "metadata": {
            "id": "8a2e83617870fa00017892848284118f",
            "audit": {
                "createTimestamp": "2021-04-02T12:17:40.996+0000",
                "createUserId": "789f8247a10c466f36894f0f3cfdce19",
                "modifyTimestamp": "2021-04-02T12:17:40.996+0000",
                "modifyUserId": "789f8247a10c466f36894f0f3cfdce19"
            },
            "scope": {
                "id": "8a2e96e67870fa1c01788e7e19d30ed0",
                "kind": "Environment",
                "name": "manualenv",
                "selfLink": "/management/v1alpha1/environments/manualenv"
            },
            "resourceVersion": "286975",
            "references": [
                {
                    "id": "8a2e83617870fa00017892848124118d",
                    "kind": "APIServiceRevision",
                    "name": "comprehend-version",
                    "type": "hard",
                    "selfLink": "/management/v1alpha1/environments/manualenv/apiservicerevisions/comprehend-version"
                }
            ],
            "selfLink": "/management/v1alpha1/environments/manualenv/apiserviceinstances/comprehend-endpoint"
        },
        "apiVersion": "v1alpha1",
        "kind": "APIServiceInstance",
        "name": "comprehend-endpoint",
        "attributes": {},
        "title": "comprehend",
        "spec": {
            "endpoint": [],
            "apiServiceRevision": "comprehend-version"
        },
        "group": "management",
        "tags": []
    }
}

In each case, the headers looked similar to the following, including the Authorization header which contains the secret set above, Password123:

Host: en9c5wvi5vta4.x.pipedream.net
X-Amzn-Trace-Id: Root=1-6065c447-3c5b35a840f6e43e078b9c79
Content-Length: 1295
Authorization: Password123
X-Axway-Event-Id: 170d3081-9c48-459e-82e2-f37f5e3f1d74
User-Agent: amplify-central
Accept: application/json
Content-Type: application/json

Summary

In this blog post, we looked at an example of how to set up an Integration Webhook for all resources in a particular Amplify Central environment using Amplify Central API calls. The webhook calls were sent to requestbin for analysis but in a real-world application, the webhooks would trigger your application, which would parse the payload and perform the necessary actions.

In the next blog post, we’ll look at an example of an Integration Builder flow that processes Integration Webhooks.

Learn more about Amplify Central.