Configure custom webhooks in Postman

Postman’s custom webhook integration enables you to automate workflows between your favorite apps and services to get notifications, synchronize files, collect data, and more. It offers services with predefined workflows that you can implement.

You can configure a custom webhook with Postman to send events such as monitor results or team and collection-specific activity feeds, or to back up your Postman Collections.

Enable static IP support

If your network is behind a firewall, you will need to use a static IP address to enable collection backups to custom webhooks on custom domains.

Contact your IT team to allowlist the following static IP in your firewall to enable collection backups to webhooks:

• US East: 3.212.102.200

Once you allowlist this IP address, calls for the custom webhook will be able to connect to your network and enable the webhook to work as expected.

Configure custom webhooks

1. In Postman, click Integrations in the left sidebar. Click Browse All Integrations.

2. Search for and select Webhooks from the list of integrations.

   The Integrations page has choices for each type of custom webhook. If available, you can view previously configured integrations for the selected integration.

3. Click Add Integration next to a webhook type to configure your integration. Complete the steps in the related section below for the webhook type you want to add.

Once the integration has been created, you can view it with the other active integrations created by your team.

Send updates for a Postman Collection to a custom webhook

To send collection updates to a custom webhook, do the following:

1. On the Webhooks Integrations page, next to Backup a collection, click Add Integration.
2. On the Add integration page:
   • Enter a Nickname for the integration.
   • Under Choose workspace, select the workspace your collection belongs to.
   • Under Choose Collection, select the collection you wish to send updates for.
   • Enter the webhook URL your webhook payload will be sent to.
3. Click Add Integration.

Postman periodically checks your collection for changes. If Postman identifies changes when it checks your collection, the changes automatically send to your custom webhook.

Example collection backup schema

The following is a schema for the Backup a collection webhook:

1
{
2
  "$schema": "http://json-schema.org/draft-04/schema#",
3
  "definitions": {},
4
  "id": "http://example.com/example.json",
5
  "properties": {
6
    "collection": {
7
      "id": "/properties/collection",
8
      "properties": {},
9
      "type": "object"
10
    }
11
  },
12
  "type": "object"
13
}

Send monitor results to custom webhooks

With Postman Monitors you can run your collections on a schedule without any manual intervention. By using custom webhooks you can use those monitor results by connecting to other available services.

To send monitor results to a custom webhook, do the following:

1. On the Webhooks Integrations page, next to Post monitoring results, click Add Integration.
2. On the Add integration page:
   • Enter a Nickname for the integration.
   • Select the workspace containing the monitor you want to send to a custom webhook.
   • Select the monitor for which you want to send results.
   • Enter the webhook URL your webhook payload will be sent to.
   • Select Notify for all completed monitor runs or Notify for 3 failures and then first success.
3. Click Add Integration.

Whenever your monitor runs, the results are posted to your webhook.

Example monitor result schema

The following is a schema for the Post monitoring results webhook:

1
{
2
  "$schema": "http://json-schema.org/draft-04/schema#",
3
  "definitions": {},
4
  "id": "http://example.com/example.json",
5
  "properties": {
6
    "collection_name": {
7
      "id": "/properties/collection_name",
8
      "type": "string"
9
    },
10
    "collection_uid": {
11
      "id": "/properties/collection_uid",
12
      "type": "string"
13
    },
14
    "environment_name": {
15
      "id": "/properties/environment_name",
16
      "type": "string"
17
    },
18
    "environment_uid": {
19
      "id": "/properties/environment_uid",
20
      "type": "string"
21
    },
22
    "metrics": {
23
      "id": "/properties/metrics",
24
      "properties": {
25
        "errors":
26
          "id": "/properties/metrics/properties/errors",
27
          "type": "integer"
28
        },
29
        "failedTests": {
30
          "id": "/properties/metrics/properties/failedTests",
31
          "type": "integer"
32
        },
33
        "passedTests": {
34
          "id": "/properties/metrics/properties/passedTests",
35
          "type": "integer"
36
        },
37
        "requestCount": {
38
          "id": "/properties/metrics/properties/requestCount",
39
          "type": "integer"
40
        },
41
        "totalLatency": {
42
          "id": "/properties/metrics/properties/totalLatency",
43
          "type": "integer"
44
        },
45
        "warnings": {
46
          "id": "/properties/metrics/properties/warnings",
47
          "type": "integer"
48
        }
49
      },
50
      "type": "object"
51
    },
52
    "monitor_name": {
53
      "id": "/properties/monitor_name",
54
      "type": "string"
55
    },
56
    "monitor_uid": {
57
      "id": "/properties/monitor_uid",
58
      "type": "string"
59
    },
60
    "user_id": {
61
      "id": "/properties/user_id",
62
      "type": "string"
63
    },
64
    "user_name": {
65
      "id": "/properties/user_name",
66
      "type": "string"
67
    }
68
  },
69
  "type": "object"
70
}

Send a team activity feed to custom webhooks

The activity feed is where you can track changes made to your collections and within your team.

To send team activity to custom webhooks, do the following:

1. On the Webhooks Integrations page, next to Post team activity, click Add Integration.
2. On the Add integration page:
   • Enter a Nickname for the integration.
   • Enter the webhook URL to send team updates to this specific URL.
3. Click Add Integration.

Example team activity schema

The following is a schema for the Post team activity webhook:

1
{
2
  "$schema": "http://json-schema.org/draft-04/schema#",
3
  "definitions": {},
4
  "id": "http://example.com/example.json",
5
  "properties": {
6
    "action": {
7
      "id": "/properties/action",
8
      "type": "string"
9
    },
10
    "collection_name": {
11
      "id": "/properties/collection_name",
12
      "type": "string"
13
    },
14
    "collection_uid": {
15
      "id": "/properties/collection_uid",
16
      "type": "string"
17
    },
18
    "message": {
19
      "id": "/properties/message",
20
      "type": "string"
21
    },
22
    "model": {
23
      "id": "/properties/model",
24
      "type": "string"
25
    },
26
    "model_name": {
27
      "id": "/properties/model_name",
28
      "type": "string"
29
    },
30
    "model_uid": {
31
      "id": "/properties/model_uid",
32
      "type": "string"
33
    },
34
    "user_id": {
35
      "id": "/properties/user_id",
36
      "type": "string"
37
    },
38
    "user_name": {
39
      "id": "/properties/user_name",
40
      "type": "string"
41
    }
42
  },
43
  "type": "object"
44
}