Openpath orgs/hookActions API
The orgs/hookActions API from Openpath — 2 operation(s) for orgs/hookactions.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/openpath-orgs-hookactions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Openpath API Documentation auth Orgs/hook Actions API
version: 1.0.0
description: Authentication and Login
servers:
- url: https://api.openpath.com
tags:
- name: orgs/hookActions
paths:
/orgs/{orgId}/hookActions:
get:
summary: List all hook actions
operationId: listHookActions
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-outboundWebhooks:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listHookActions'
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
- name: limit
in: query
schema:
type: integer
maximum: 1000
minimum: 1
- name: offset
in: query
schema:
type: integer
default: 0
minimum: 0
- name: sort
in: query
schema:
type: string
default: name
pattern: ^[a-zA-Z0-9.]+(,\s*[a-zA-Z0-9.]+)*$
- name: order
in: query
schema:
type: string
default: asc
pattern: ^(asc|desc)+(,\s*(asc|desc)+)*$
- name: q
in: query
schema:
type: string
- name: filter
in: query
schema:
type: string
- name: preFilter
in: query
schema:
type: string
tags:
- orgs/hookActions
security:
- jwt: []
responses:
'200':
description: Successful
content:
application/json:
schema:
type: object
properties:
totalCount:
type: integer
filteredCount:
type: integer
data:
type: array
items:
type: object
properties:
id:
type: number
name:
type: string
description:
type:
- string
- 'null'
config:
type: object
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
required:
- id
meta:
type: object
properties:
accessToken:
type:
- object
- 'null'
properties:
scopeUpdatedAt:
type: string
format: date
siteSpecificAccess:
type:
- object
- 'null'
properties:
isSiteSpecific:
type: boolean
siteIds:
type:
- array
- 'null'
items:
type: integer
siteIdsByScope:
type:
- object
- 'null'
properties:
string:
type:
- array
- 'null'
items:
type: integer
x-op-scopes:
- o{params.orgId}-configurations:w
- o{params.orgId}-configurations:r
- o{params.orgId}-outboundWebhooks:w
- o{params.orgId}-outboundWebhooks:r
- o:w
- o:r
- s-o:w
- s-o:r
post:
summary: Create a hook action
operationId: createHookAction
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-outboundWebhooks:w,o:w,s-o:w<br/><br/>__Endpoint name__: createHookAction'
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
tags:
- orgs/hookActions
security:
- jwt: []
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: number
name:
type: string
description:
type:
- string
- 'null'
config:
type: object
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
required:
- id
meta:
type: object
properties:
accessToken:
type:
- object
- 'null'
properties:
scopeUpdatedAt:
type: string
format: date
siteSpecificAccess:
type:
- object
- 'null'
properties:
isSiteSpecific:
type: boolean
siteIds:
type:
- array
- 'null'
items:
type: integer
siteIdsByScope:
type:
- object
- 'null'
properties:
string:
type:
- array
- 'null'
items:
type: integer
x-op-scopes:
- o{params.orgId}-configurations:w
- o{params.orgId}-outboundWebhooks:w
- o:w
- s-o:w
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
minLength: 1
maxLength: 100
x-convert:
trim: true
config:
x-alternatives:
- type: object
properties:
version:
type: string
trigger:
type: object
requests:
type: array
items:
x-alternatives:
- type: object
- type: object
properties:
type:
type: string
locationId:
type: integer
enum:
- 1
- 2
- 3
- 4
data:
type: object
properties:
withSourceEvent:
type: boolean
withListNulls:
type: boolean
notificationData:
type: object
properties:
titleText:
type: string
subtitleText:
type: string
type:
type: string
enum:
- success
- info
- warning
- error
- alarmLow
- alarmMedium
- alarmHigh
icon:
type: string
enum:
- success
- info
- warning
- error
- p1
- p2
- p3
- p4
- p5
buttons:
type: array
items:
x-alternatives:
- type: object
- type: object
properties:
target:
type: object
properties:
resourceType:
type: string
resourceUid:
type: string
x-format:
guid: true
x-alternatives:
- type: string
x-format:
guid: true
- type: string
pattern: '[1-9][0-9]*'
- type: string
pattern: ^{{toString [^}]+}}$
required:
- resourceType
- resourceUid
type: object
org:
type: object
properties:
id:
type: integer
minimum: 1
originUserId:
type:
- integer
- 'null'
minimum: 1
x-alternatives:
- type: integer
minimum: 1
- type: string
pattern: ^{{toInt [^}]+}}$
originUserOpal:
type:
- string
- 'null'
recipientUserIds:
type: array
items:
type: integer
minimum: 1
recipientRoleIds:
type: array
items:
type: integer
minimum: 1
required:
- titleText
- subtitleText
- type
- icon
- org
required:
- notificationData
required:
- data
- type: object
properties:
type:
type: string
blocking:
type: boolean
enum:
- false
preRequestDelaySeconds:
type: integer
enum:
- 0
locationId:
type: number
enum:
- 4
authType:
type: string
enum:
- basic
- customString
- url
alertCode:
type: string
httpParams:
type: object
properties:
headers:
type: array
minItems: 2
maxItems: 3
items:
type: string
pattern: '^User-Agent: Openpath\/(Rules Engine|RulesEngine|AlarmConfig)$'
method:
type: string
enum:
- get
- post
url:
type: string
x-format:
uri: true
required:
- url
data:
type: object
required:
- locationId
- authType
- alertCode
type: object
- type: string
type: object
properties:
version:
type: string
trigger:
type: object
requests:
type: array
items:
x-alternatives:
- type: object
- type: object
properties:
type:
type: string
locationId:
type: integer
enum:
- 1
- 2
- 3
- 4
data:
type: object
properties:
withSourceEvent:
type: boolean
withListNulls:
type: boolean
notificationData:
type: object
properties:
titleText:
type: string
subtitleText:
type: string
type:
type: string
enum:
- success
- info
- warning
- error
- alarmLow
- alarmMedium
- alarmHigh
icon:
type: string
enum:
- success
- info
- warning
- error
- p1
- p2
- p3
- p4
- p5
buttons:
type: array
items:
x-alternatives:
- type: object
- type: object
properties:
target:
type: object
properties:
resourceType:
type: string
resourceUid:
type: string
x-format:
guid: true
x-alternatives:
- type: string
x-format:
guid: true
- type: string
pattern: '[1-9][0-9]*'
- type: string
pattern: ^{{toString [^}]+}}$
required:
- resourceType
- resourceUid
type: object
org:
type: object
properties:
id:
type: integer
minimum: 1
originUserId:
type:
- integer
- 'null'
minimum: 1
x-alternatives:
- type: integer
minimum: 1
- type: string
pattern: ^{{toInt [^}]+}}$
originUserOpal:
type:
- string
- 'null'
recipientUserIds:
type: array
items:
type: integer
minimum: 1
recipientRoleIds:
type: array
items:
type: integer
minimum: 1
required:
- titleText
- subtitleText
- type
- icon
- org
required:
- notificationData
required:
- data
- type: object
properties:
type:
type: string
blocking:
type: boolean
enum:
- false
preRequestDelaySeconds:
type: integer
enum:
- 0
locationId:
type: number
enum:
- 4
authType:
type: string
enum:
- basic
- customString
- url
alertCode:
type: string
httpParams:
type: object
properties:
headers:
type: array
minItems: 2
maxItems: 3
items:
type: string
pattern: '^User-Agent: Openpath\/(Rules Engine|RulesEngine|AlarmConfig)$'
method:
type: string
enum:
- get
- post
url:
type: string
x-format:
uri: true
required:
- url
data:
type: object
required:
- locationId
- authType
- alertCode
type: object
description:
type:
- string
- 'null'
required:
- name
- config
/orgs/{orgId}/hookActions/{hookActionId}:
get:
summary: Describe a hook action
operationId: describeHookAction
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-outboundWebhooks:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeHookAction'
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
- name: hookActionId
in: path
required: true
schema:
type: integer
tags:
- orgs/hookActions
security:
- jwt: []
responses:
'200':
description: Successful
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: number
name:
type: string
description:
type:
- string
- 'null'
config:
type: object
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
required:
- id
meta:
type: object
properties:
accessToken:
type:
- object
- 'null'
properties:
scopeUpdatedAt:
type: string
format: date
siteSpecificAccess:
type:
- object
- 'null'
properties:
isSiteSpecific:
type: boolean
siteIds:
type:
- array
- 'null'
items:
type: integer
siteIdsByScope:
type:
- object
- 'null'
properties:
string:
type:
- array
- 'null'
items:
type: integer
x-op-scopes:
- o{params.orgId}-configurations:w
- o{params.orgId}-configurations:r
- o{params.orgId}-outboundWebhooks:w
- o{params.orgId}-outboundWebhooks:r
- o:w
- o:r
- s-o:w
- s-o:r
delete:
summary: Delete a hook action
operationId: deleteHookAction
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-outboundWebhooks:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteHookAction'
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
- name: hookActionId
in: path
required: true
schema:
type: integer
tags:
- orgs/hookActions
security:
- jwt: []
responses:
'204':
description: No Content
x-op-scopes:
- o{params.orgId}-configurations:w
- o{params.orgId}-outboundWebhooks:w
- o:w
- s-o:w
patch:
summary: Update a hook action
operationId: updateHookAction
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-outboundWebhooks:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateHookAction'
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
- name: hookActionId
in: path
required: true
schema:
type: integer
tags:
- orgs/hookActions
security:
- jwt: []
responses:
'204':
description: No Content
x-op-scopes:
- o{params.orgId}-configurations:w
- o{params.orgId}-outboundWebhooks:w
- o:w
- s-o:w
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
minLength: 1
maxLength: 100
x-convert:
trim: true
description:
type:
- string
- 'null'
config:
x-alternatives:
- type: object
properties:
version:
type: string
trigger:
type: object
requests:
type: array
items:
x-alternatives:
- type: object
- type: object
properties:
type:
type: string
locationId:
type: integer
enum:
- 1
- 2
- 3
- 4
data:
type: object
properties:
withSourceEvent:
type: boolean
withListNulls:
type: boolean
notificationData:
type: object
properties:
titleText:
type: string
subtitleText:
type: string
type:
type: string
enum:
- success
- info
- warning
- error
- alarmLow
- alarmMedium
- alarmHigh
icon:
type: string
enum:
- success
- info
- warning
- error
- p1
- p2
- p3
- p4
- p5
buttons:
type: array
items:
x-alternatives:
- type: object
- type: object
properties:
target:
type: object
properties:
res
# --- truncated at 32 KB (45 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openpath/refs/heads/main/openapi/openpath-orgs-hookactions-api-openapi.yml