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.
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:
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.
On the Integrations page, search and select Webhooks from the list of integrations.
The integration's page has choices for each type of custom webhook. If available, you can view previously configured integrations for the selected integration.
Select Add Integration next to a webhook type to configure your integration. Perform the steps in the related section below for the webhook type you are adding.
Once the integration has been created, you can view the integration you created in addition to the other active integrations created by your team:
Postman periodically checks your collection for changes. If Postman identifies changes when it checks your collection, the changes automatically send to your custom webhook.
The following is a schema for the Backup a collection webhook:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"collection": {
"id": "/properties/collection",
"properties": {},
"type": "object"
}
},
"type": "object"
}
Postman Monitors enable you to run your collections on a schedule without any manual intervention. By using custom webhooks you can use those results by connecting to other available services.
Whenever your monitor runs, the results are posted to your webhook.
The following is a schema for the Post monitoring results webhook:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"collection_name": {
"id": "/properties/collection_name",
"type": "string"
},
"collection_uid": {
"id": "/properties/collection_uid",
"type": "string"
},
"environment_name": {
"id": "/properties/environment_name",
"type": "string"
},
"environment_uid": {
"id": "/properties/environment_uid",
"type": "string"
},
"metrics": {
"id": "/properties/metrics",
"properties": {
"errors":
"id": "/properties/metrics/properties/errors",
"type": "integer"
},
"failedTests": {
"id": "/properties/metrics/properties/failedTests",
"type": "integer"
},
"passedTests": {
"id": "/properties/metrics/properties/passedTests",
"type": "integer"
},
"requestCount": {
"id": "/properties/metrics/properties/requestCount",
"type": "integer"
},
"totalLatency": {
"id": "/properties/metrics/properties/totalLatency",
"type": "integer"
},
"warnings": {
"id": "/properties/metrics/properties/warnings",
"type": "integer"
}
},
"type": "object"
},
"monitor_name": {
"id": "/properties/monitor_name",
"type": "string"
},
"monitor_uid": {
"id": "/properties/monitor_uid",
"type": "string"
},
"user_id": {
"id": "/properties/user_id",
"type": "string"
},
"user_name": {
"id": "/properties/user_name",
"type": "string"
}
},
"type": "object"
}
The activity feed is where you can track changes made to your collections and within your team.
The following is a schema for the Post team activity webhook:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"action": {
"id": "/properties/action",
"type": "string"
},
"collection_name": {
"id": "/properties/collection_name",
"type": "string"
},
"collection_uid": {
"id": "/properties/collection_uid",
"type": "string"
},
"message": {
"id": "/properties/message",
"type": "string"
},
"model": {
"id": "/properties/model",
"type": "string"
},
"model_name": {
"id": "/properties/model_name",
"type": "string"
},
"model_uid": {
"id": "/properties/model_uid",
"type": "string"
},
"user_id": {
"id": "/properties/user_id",
"type": "string"
},
"user_name": {
"id": "/properties/user_name",
"type": "string"
}
},
"type": "object"
}
Last modified: 2024/08/30
Additional resources
Blog posts
Case Studies
Public workspaces