Hooks

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.

List hooks

get

/hooks

Retrieves a collection of all hooks for a team with a given ID. Returned hooks are sorted by name in ascending order.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Query parameters

teamIdstringRequired

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

Example: 4

typeNamestringOptional

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

Example: gateway-webhook

assignedbooleanOptional

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.

Example: true

viewForScenarioIdintegerOptional

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.

Example: 123

Responses

200

Successful response

application/json

get

/hooks

GET /api/v2/hooks?teamId=text HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "hooks": [
    {
      "id": 11,
      "name": "My gateway-webhook webhook 1",
      "teamId": 4,
      "udid": "1gqnexkk1vwxg2wpj39kg30pzp6uhe7h",
      "type": "web",
      "packageName": null,
      "theme": "#c73a63",
      "editable": true,
      "queueCount": 0,
      "queueLimit": 10000,
      "enabled": true,
      "gone": false,
      "typeName": "gateway-webhook",
      "data": {
        "headers": false,
        "method": false,
        "stringify": false
      },
      "scenarioId": 1,
      "url": "https://local.make.cloud/wh/1gqnexkk1vwxg2wpj39kg30pzp6uhe7h"
    },
    {
      "id": 58,
      "name": "Test 1",
      "teamId": 4,
      "udid": "d4ezzfwgyav7qaukv8dbh3l21eru0fld",
      "type": "web",
      "packageName": null,
      "theme": "#c73a63",
      "editable": true,
      "queueCount": 0,
      "queueLimit": 10000,
      "enabled": true,
      "gone": false,
      "typeName": "gateway-webhook",
      "data": {
        "ip": null,
        "udt": null,
        "headers": false,
        "method": false,
        "stringify": false,
        "teamId": 4
      },
      "scenarioId": 112,
      "url": "https://local.make.cloud/wh/d4ezzfwgyav7qaukv8dbh3l21eru0fld"
    }
  ]
}

Create hook

post

/hooks

Creates a new hook with data passed in the request body. In the response, it returns all details of the created hook.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Body

namestringRequired

The name of the hook. The name must be at most 128 characters long and does not need to be unique.

teamIdstringRequired

The unique ID of the team in which a hook will be created.

typeNamestringRequired

The hook type strictly related to the app for which the hook was created.

methodbooleanRequired

Set the method parameter to true to add the HTTP method to the request body.

headerbooleanRequired

Set the header parameter to true to add headers to the request body.

stringifybooleanRequired

Set the stringify parameter to true to return JSON payloads as strings.

__IMTCONN__integerOptional

The unique ID of the connection that will be included in the created hook.

formIdstringOptional

The unique ID of the form that will be included in the created hook.

Responses

200

Successful response

application/json

post

/hooks

POST /api/v2/hooks HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "name": "Jotform hook 1",
  "teamId": "1",
  "typeName": "jotform",
  "method": false,
  "header": false,
  "stringify": false,
  "__IMTCONN__": 96,
  "formId": "91282545501352"
}

200

Successful response

{
  "hook": {
    "id": 46,
    "name": "jotform hook 1",
    "teamId": 4,
    "udid": "ukkxypkmrcgufv8xmc9xumbvh8bfh69d",
    "type": "web",
    "packageName": null,
    "theme": "#ffa500",
    "editable": false,
    "queueCount": 0,
    "queueLimit": 10000,
    "enabled": true,
    "gone": false,
    "typeName": "jotform",
    "data": {
      "__IMTCONN__": 96,
      "formId": "91282545501352",
      "teamId": 4,
      "url": "https://local.make.cloud/wh/ukkxypkmrcgufv8xmc9xumbvh8bfh69d"
    },
    "url": "https://local.make.cloud/wh/ukkxypkmrcgufv8xmc9xumbvh8bfh69d"
  }
}

Get hook details

get

/hooks/{hookId}

Retrieves details of a hook with a given ID including hooks data.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

hookIdintegerRequired

The ID of the webhook. Use the GET /hooks API call to get the ID values of your webhooks.

Example: 654

Responses

200

Successful response

application/json

get

/hooks/{hookId}

GET /api/v2/hooks/{hookId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "hook": {
    "id": 58,
    "name": "Test 1",
    "teamId": 4,
    "udid": "d4ezzfwgyav7qaukv8dbh3l21eru0fld",
    "type": "web",
    "packageName": null,
    "theme": "#c73a63",
    "editable": true,
    "queueCount": 0,
    "queueLimit": 10000,
    "enabled": true,
    "gone": false,
    "typeName": "gateway-webhook",
    "data": {
      "ip": null,
      "udt": null,
      "headers": false,
      "method": false,
      "stringify": false,
      "teamId": 4
    },
    "scenarioId": 112,
    "url": "https://local.make.cloud/wh/d4ezzfwgyav7qaukv8dbh3l21eru0fld"
  }
}

Delete hook

delete

/hooks/{hookId}

Deletes a hook with a given ID and returns the ID in the response.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

hookIdintegerRequired

The ID of the webhook. Use the GET /hooks API call to get the ID values of your webhooks.

Example: 654

Query parameters

confirmedbooleanOptional

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

Example: true

Responses

200

Successful response

application/json

delete

/hooks/{hookId}

DELETE /api/v2/hooks/{hookId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "hook": 12
}

Update hook

patch

/hooks/{hookId}

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.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

hookIdintegerRequired

The ID of the webhook. Use the GET /hooks API call to get the ID values of your webhooks.

Example: 654

Body

namestringOptional

The name of the updated hook. The name must be at most 128 characters long and does not need to be unique.

Responses

200

Successful response

application/json

patch

/hooks/{hookId}

PATCH /api/v2/hooks/{hookId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "name": "My gateway-webhook webhook 1"
}

200

Successful response

{
  "hook": {
    "id": 11,
    "name": "My gateway-webhook webhook 1",
    "teamId": 4,
    "udid": "1gqnexkk1vwxg2wpj39kg30pzp6uhe7h",
    "type": "web",
    "packageName": null,
    "theme": "#c73a63",
    "editable": true,
    "queueCount": 0,
    "queueLimit": 10000,
    "enabled": true,
    "gone": false,
    "typeName": "gateway-webhook",
    "data": {
      "headers": false,
      "method": false,
      "stringify": false
    },
    "url": "https://local.make.cloud/wh/1gqnexkk1vwxg2wpj39kg30pzp6uhe7h"
  }
}

Ping hook

get

/hooks/{hookId}/ping

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.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

hookIdintegerRequired

The ID of the webhook. Use the GET /hooks API call to get the ID values of your webhooks.

Example: 654

Responses

200

Successful response

application/json

get

/hooks/{hookId}/ping

GET /api/v2/hooks/{hookId}/ping HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "address": "https://local.make.cloud/wh/wmhqi8todng3en3z2tl7ausm15tg33iz",
  "attached": false,
  "learning": false,
  "gone": false
}

Learn start

post

/hooks/{hookId}/learn-start

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.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

hookIdintegerRequired

The ID of the webhook. Use the GET /hooks API call to get the ID values of your webhooks.

Example: 654

Responses

200

Successful response

application/json

post

/hooks/{hookId}/learn-start

POST /api/v2/hooks/{hookId}/learn-start HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "success": true
}

Learn stop

post

/hooks/{hookId}/learn-stop

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.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

hookIdintegerRequired

The ID of the webhook. Use the GET /hooks API call to get the ID values of your webhooks.

Example: 654

Responses

200

Successful response

application/json

post

/hooks/{hookId}/learn-stop

POST /api/v2/hooks/{hookId}/learn-stop HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "success": true
}

Enable hook

post

/hooks/{hookId}/enable

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.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

hookIdintegerRequired

The ID of the webhook. Use the GET /hooks API call to get the ID values of your webhooks.

Example: 654

Responses

200

Successful response

application/json

post

/hooks/{hookId}/enable

POST /api/v2/hooks/{hookId}/enable HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "success": true
}

Disable hook

post

/hooks/{hookId}/disable

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.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

hookIdintegerRequired

The ID of the webhook. Use the GET /hooks API call to get the ID values of your webhooks.

Example: 654

Responses

200

Successful response

application/json

post

/hooks/{hookId}/disable

POST /api/v2/hooks/{hookId}/disable HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "success": true
}

Set hook details

post

/hooks/{hookId}/set-data

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

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

hookIdintegerRequired

The ID of the webhook. Use the GET /hooks API call to get the ID values of your webhooks.

Example: 654

Body

objectOptional

Responses

200

Successful response

application/json

post

/hooks/{hookId}/set-data

POST /api/v2/hooks/{hookId}/set-data HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "ip": "",
  "udt": "",
  "headers": false,
  "method": false,
  "stringify": false
}

200

Successful response

{
  "changed": true
}

PreviousGeneral NextHooks > Incomings

Last updated 1 day ago

hashtagList hooks

hashtagCreate hook

hashtagGet hook details

hashtagDelete hook

hashtagUpdate hook

hashtagPing hook

hashtagLearn start

hashtagLearn stop

hashtagEnable hook

hashtagDisable hook

hashtagSet hook details

List hooks

Create hook

Get hook details

Delete hook

Update hook

Ping hook

Learn start

Learn stop

Enable hook

Disable hook

Set hook details