Hooks refer to the webhooks and mailhooks available in the various apps in the Make interface. They notify you whenever a certain change occurs in the connected app or service, such as sending an HTTP request or an email. The following endpoints allow you to create and manage hooks.
Retrieves details of a hook with a given ID including hooks data.
The ID of the webhook. Use the GET /hooks API call to get the ID values of your webhooks.
654Successful response
Deletes a hook with a given ID and returns the ID in the response.
The ID of the webhook. Use the GET /hooks API call to get the ID values of your webhooks.
654Confirms the deletion if a hook is included in the scenario. Confirmation is required because the scenario will stop working without the hook. If the parameter is missing or it is set to false an error code is returned and the resource is not deleted.
trueSuccessful response
Determines if a hook with a given ID is active and retrieves its properties that provide you with the address of the hook and inform if the hook is attached, what is its learning status, and if it was not used for a long time.
The ID of the webhook. Use the GET /hooks API call to get the ID values of your webhooks.
654Successful response
Starts the process of learning the request body structure by a hook with a given ID. When you send to the hook address a request with data in its body, you can use this endpoint to force the hook to start determining the payload data structure which will later be suggested in the scenario as the output of the hook. The data structure learning process also starts automatically when a new hook is created and stops once the data structure is determined. If you want to stop this process, you can use the Learn stop endpoint.
The ID of the webhook. Use the GET /hooks API call to get the ID values of your webhooks.
654Successful response
Stops the process of learning the request body structure by a hook with a given ID. When you send to the hook address a request with data in its body, you can use the Learn start endpoint to force the hook to start determining the payload data structure which will later be suggested in the scenario as the output of the hook. The data structure learning process also starts automatically when a new hook is created and stops once the data structure is determined. You can use this endpoint to stop the learning process at any time.
The ID of the webhook. Use the GET /hooks API call to get the ID values of your webhooks.
654Successful response
Enables a disabled hook with a given ID. Newly created hooks are enabled by default which means they are ready to accept data. In response, this endpoint returns the confirmation that the hook was successfully enabled.
The ID of the webhook. Use the GET /hooks API call to get the ID values of your webhooks.
654Successful response
Disables a hook with a given ID. Newly created hooks are enabled by default which means they are ready to accept data. The disabled hook does not accept any data. This endpoint can be useful when you want to debug the scenario functionality. In response, this endpoint returns the confirmation that the hook was successfully disabled.
The ID of the webhook. Use the GET /hooks API call to get the ID values of your webhooks.
654Successful response
Retrieves a collection of all hooks for a team with a given ID. Returned hooks are sorted by name in ascending order.
The unique ID of the team whose hooks will be retrieved.
4The hook type. Two native Make hook types are gateway-webhook and gateway-mailhook.
gateway-webhookSpecifies if the hook is assigned to a scenario. If set to true, the request will return only the hooks which the scenarioId value is not set to null.
trueThis parameter shows only the hooks that can be used by a scenario with a specific ID, which means hooks that are not assigned to another scenario yet and the hook that is already assigned to this scenario. This can be useful because Make allows assigning any hook to only one scenario. If this parameter is set the assigned parameter is ignored.
123Successful response
Creates a new hook with data passed in the request body. In the response, it returns all details of the created hook.
The name of the hook. The name must be at most 128 characters long and does not need to be unique.
The unique ID of the team in which a hook will be created.
The hook type strictly related to the app for which the hook was created.
Set the method parameter to true to add the HTTP method to the request body.
Set the header parameter to true to add headers to the request body.
Set the stringify parameter to true to return JSON payloads as strings.
The unique ID of the connection that will be included in the created hook.
The unique ID of the form that will be included in the created hook.
Successful response
Updates a hook with a given ID by passing new values in the request body. Any property that is not provided will be left unchanged. In the response, it returns all details of the updated hook including properties that were not changed.
The ID of the webhook. Use the GET /hooks API call to get the ID values of your webhooks.
654The name of the updated hook. The name must be at most 128 characters long and does not need to be unique.
Successful response
Sets data for a hook with a given ID. Data differ depending on the hook type. It returns the confirmation if the hook data was changed (true) or not (false).
The ID of the webhook. Use the GET /hooks API call to get the ID values of your webhooks.
654Successful response