{
"opencollection": "1.0.0",
"info": {
"name": "Port Action Runs Webhook API",
"version": "1.0"
},
"items": [
{
"info": {
"name": "Webhook",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get all webhooks",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v1/webhooks",
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "This route allows you to fetch all webhooks configured in your Port organization. You can also see them in the [data sources page](https://app.getport.io/settings/data-sources) of your Port account.
To learn more about webhooks, check out the [documentation](https://docs.port.io/build-your-software-catalog/custom-integration/webhook/).
**Permission requirements**
To use this endpoint, you must have a `moderator` or `admin` role in your Port organization.
To learn more about "
},
{
"info": {
"name": "Create a webhook",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v1/webhooks",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "This route allows you to create a webhook in your Port organization. You can also create it via the [data sources page](https://app.getport.io/settings/data-sources) of your Port account.
To learn more about webhooks, check out the [documentation](https://docs.port.io/build-your-software-catalog/custom-integration/webhook/)."
},
{
"info": {
"name": "Get a webhook",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v1/webhooks/:identifier",
"params": [
{
"name": "identifier",
"value": "",
"type": "path",
"description": "The unique identifier of the resource you want to operate on."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "This route allows you to fetch a specific webhook in your Port organization. You can also see it in the [data sources page](https://app.getport.io/settings/data-sources) of your Port account.
To learn more about webhooks, check out the [documentation](https://docs.port.io/build-your-software-catalog/custom-integration/webhook/).
**Permission requirements**
To use this endpoint, you must have a `moderator` or `admin` role in your Port organization.
To learn more about the dif"
},
{
"info": {
"name": "Change a webhook",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/v1/webhooks/:identifier",
"params": [
{
"name": "identifier",
"value": "",
"type": "path",
"description": "The unique identifier of the resource you want to operate on."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "This route allows you to modify a webhook in your Port organization. You can also modify it via the [data sources page](https://app.getport.io/settings/data-sources) of your Port account.
To learn more about webhooks, check out the [documentation](https://docs.port.io/build-your-software-catalog/custom-integration/webhook/)."
},
{
"info": {
"name": "Update a webhook",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/v1/webhooks/:identifier",
"params": [
{
"name": "identifier",
"value": "",
"type": "path",
"description": "The unique identifier of the resource you want to operate on."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "This route allows you to modify a webhook in your Port organization. You can also modify it via the [data sources page](https://app.getport.io/settings/data-sources) of your Port account.
To learn more about webhooks, check out the [documentation](https://docs.port.io/build-your-software-catalog/custom-integration/webhook/)."
},
{
"info": {
"name": "Delete a webhook",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/v1/webhooks/:identifier",
"params": [
{
"name": "identifier",
"value": "",
"type": "path",
"description": "The unique identifier of the resource you want to operate on."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "This route allows you to delete a webhook in your Port organization. You can also delete it via the [data sources page](https://app.getport.io/settings/data-sources) of your Port account.
To learn more about webhooks, check out the [documentation](https://docs.port.io/build-your-software-catalog/custom-integration/webhook/)."
},
{
"info": {
"name": "Get all webhooks meta-data (member view)",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v1/webhooks/metadata",
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "This route allows members to fetch meta-data on all webhooks in their Port organization.
The response includes each webhook's identifier, title, icon, and last update timestamp."
}
]
}
],
"bundled": true
}