v1

latestOpenAPI 3.0.02026-07-23620132.5 KB
Hooks

List hooks

Retrieves a collection of all hooks for a team with a given ID. Returned hooks are sorted by ID in ascending order by default. Use pg[sortBy] to sort by name or hookName.

get/hooks

Query parameters

teamIdstring required

The unique ID of the team whose hooks will be retrieved.

typeNamestring

The hook type. Two native Make hook types are gateway-webhook and gateway-mailhook.

assignedboolean

Specifies 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.

viewForScenarioIdinteger

This 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.

Response

Successful response