Custom webhook

The custom webhook trigger allows you to trigger a sequence using a number of different webhook formats.

The format of the webhook call depends on the schema selected.

The URL provided in the custom webhook trigger can be called from anywhere you wish. Some examples are:

• A call from another service
• The address bar of your browser - trigger your sequence from anywhere you can access the internet!
• Set up links on your own private website

Given the nature of these URLs, please don't share them publically or anyone with the URL will be able to trigger your sequence. If your URLs do become shared, contact us and we'll reset your secret key.

Inputs

Schema

The schema defines the structure of the data provided in the webhook call. The different schemas are described below.

If you can't find a schema to suit your needs, please post in the Q&A forums with a sample payload. We will assess and see what we can do to add the new schema.

Parameters

The purpose of the parameters varies by schema. Read on to learn more about the different schemas.

Schemas

Schema 1

Schema 1 follows the same structure as the IFTTT webhook trigger.

Data can be passed from the webhook via the webhook URL. To access this data, provide up to 4 parameter names in the paramter fields. These parameters can then be used in the change variable action and variable value condition. Please see the documentation for those steps for more information on how to reference the parameters.

When setting up the webhook in whatever service you're using, the parameters should be added to the end of the webhook URL separated by a slash /. Note that you should not include the parameter names in the webhook URL - these are for use by SEQUEmatic only.

Below is an example URL including 2 parameters:

http://sequematic.com/trigger-ifttt-webhook/A1B2C3D4E5/1/event_name/param1/param2/

This would require that two parameter names are provided when setting up the trigger.

Schema 2

Schema 2 allows you to pass data to SEQUEmatic via a JSON POST request.

The JSON should be structured as follows:

{
    "Name":"Harry",
    "School":"Hogwarts",
    "House":"Gryffindor"
}

When processing the webhook request, SEQUEmatic will extract these values and store them in sequence parameters. These parameters can then be used in the change variable action and variable value condition by enclosing the parameter name in curly brackets. Please see the documentation for those steps for more information on how to reference the parameters.

In the example above, the data could be referenced using {Name}, {School} or {House}.

For example, if you had a change variable step to set hogwarts_house = {House}, the SEQUEmatic variable hogwarts_house would be set to Gryffindor.

When processing, the JSON is flattened and the parent keys are joined together using a hyphen. Considering the example JSON below:

{
    "Student": {
        "FirstName":"Harry",
        "Surname":"Potter"
    },
    "School":"Hogwarts",
    "House":"Gryffindor"
}

You can access the student's last name in your sequence using {Student-Surname}.

Schema 3

Schema 3 is very similar to Schema 2 above, however it expects the JSON payload to be passed as a field named data in an HTTP POST request.

Users have found this schema useful when triggering sequences from the Emby media platform.