679 lines
12 KiB
TypeScript
679 lines
12 KiB
TypeScript
import type { INodeProperties } from 'n8n-workflow';
|
|
|
|
export const webhooksDescription: INodeProperties[] = [
|
|
{
|
|
"displayName": "Operation",
|
|
"name": "operation",
|
|
"type": "options",
|
|
"noDataExpression": true,
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
]
|
|
}
|
|
},
|
|
"options": [
|
|
{
|
|
"name": "Web Hook Management Delete All",
|
|
"value": "Web Hook Management Delete All",
|
|
"action": "Deletes all existing WebHook registrations.",
|
|
"description": "Deletes all existing WebHook registrations.",
|
|
"routing": {
|
|
"request": {
|
|
"method": "DELETE",
|
|
"url": "=/api/v1/webhooks"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Web Hook Management Get",
|
|
"value": "Web Hook Management Get",
|
|
"action": "Gets all registered WebHooks for a given user.",
|
|
"description": "Gets all registered WebHooks for a given user.",
|
|
"routing": {
|
|
"request": {
|
|
"method": "GET",
|
|
"url": "=/api/v1/webhooks"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Web Hook Management Post",
|
|
"value": "Web Hook Management Post",
|
|
"action": "Registers a new WebHook for a given user.",
|
|
"description": "Registers a new WebHook for a given user.",
|
|
"routing": {
|
|
"request": {
|
|
"method": "POST",
|
|
"url": "=/api/v1/webhooks"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Web Hook Management Get Filters",
|
|
"value": "Web Hook Management Get Filters",
|
|
"action": "Returns a list of all known filters you can use to register webhooks",
|
|
"description": "Returns a list of all known filters you can use to register webhooks",
|
|
"routing": {
|
|
"request": {
|
|
"method": "GET",
|
|
"url": "=/api/v1/webhooks/filters"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Web Hook Management Delete",
|
|
"value": "Web Hook Management Delete",
|
|
"action": "Deletes an existing WebHook registration.",
|
|
"description": "Deletes an existing WebHook registration.",
|
|
"routing": {
|
|
"request": {
|
|
"method": "DELETE",
|
|
"url": "=/api/v1/webhooks/{{$parameter[\"id\"]}}"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Web Hook Management Lookup",
|
|
"value": "Web Hook Management Lookup",
|
|
"action": "Looks up a registered WebHook with the given {id} for a given user.",
|
|
"description": "Looks up a registered WebHook with the given {id} for a given user.",
|
|
"routing": {
|
|
"request": {
|
|
"method": "GET",
|
|
"url": "=/api/v1/webhooks/{{$parameter[\"id\"]}}"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Web Hook Management Put",
|
|
"value": "Web Hook Management Put",
|
|
"action": "Updates an existing WebHook registration.",
|
|
"description": "Updates an existing WebHook registration.",
|
|
"routing": {
|
|
"request": {
|
|
"method": "PUT",
|
|
"url": "=/api/v1/webhooks/{{$parameter[\"id\"]}}"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"default": ""
|
|
},
|
|
{
|
|
"displayName": "DELETE /api/v1/webhooks",
|
|
"name": "operation",
|
|
"type": "notice",
|
|
"typeOptions": {
|
|
"theme": "info"
|
|
},
|
|
"default": "",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Delete All"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "GET /api/v1/webhooks",
|
|
"name": "operation",
|
|
"type": "notice",
|
|
"typeOptions": {
|
|
"theme": "info"
|
|
},
|
|
"default": "",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Get"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "POST /api/v1/webhooks",
|
|
"name": "operation",
|
|
"type": "notice",
|
|
"typeOptions": {
|
|
"theme": "info"
|
|
},
|
|
"default": "",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Post"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Description",
|
|
"name": "Description",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Description",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Post"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Filters",
|
|
"name": "Filters",
|
|
"type": "json",
|
|
"default": "[\n null\n]",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Filters",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ JSON.parse($value) }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Post"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Headers",
|
|
"name": "Headers",
|
|
"type": "json",
|
|
"default": "{}",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Headers",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ JSON.parse($value) }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Post"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "ID",
|
|
"name": "Id",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Id",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Post"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Is Paused",
|
|
"name": "IsPaused",
|
|
"type": "boolean",
|
|
"default": true,
|
|
"routing": {
|
|
"send": {
|
|
"property": "IsPaused",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Post"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Properties",
|
|
"name": "Properties",
|
|
"type": "json",
|
|
"default": "{}",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Properties",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ JSON.parse($value) }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Post"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"required": true,
|
|
"displayName": "Secret",
|
|
"name": "Secret",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Secret",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Post"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"required": true,
|
|
"displayName": "Web Hook Uri",
|
|
"name": "WebHookUri",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "WebHookUri",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Post"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "GET /api/v1/webhooks/filters",
|
|
"name": "operation",
|
|
"type": "notice",
|
|
"typeOptions": {
|
|
"theme": "info"
|
|
},
|
|
"default": "",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Get Filters"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "DELETE /api/v1/webhooks/{id}",
|
|
"name": "operation",
|
|
"type": "notice",
|
|
"typeOptions": {
|
|
"theme": "info"
|
|
},
|
|
"default": "",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Delete"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "ID",
|
|
"name": "id",
|
|
"required": true,
|
|
"description": "The WebHook ID.",
|
|
"default": "",
|
|
"type": "string",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Delete"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "GET /api/v1/webhooks/{id}",
|
|
"name": "operation",
|
|
"type": "notice",
|
|
"typeOptions": {
|
|
"theme": "info"
|
|
},
|
|
"default": "",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Lookup"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "ID",
|
|
"name": "id",
|
|
"required": true,
|
|
"default": "",
|
|
"type": "string",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Lookup"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "PUT /api/v1/webhooks/{id}",
|
|
"name": "operation",
|
|
"type": "notice",
|
|
"typeOptions": {
|
|
"theme": "info"
|
|
},
|
|
"default": "",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Put"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "ID",
|
|
"name": "id",
|
|
"required": true,
|
|
"description": "The WebHook ID.",
|
|
"default": "",
|
|
"type": "string",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Put"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Description",
|
|
"name": "Description",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Description",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Put"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Filters",
|
|
"name": "Filters",
|
|
"type": "json",
|
|
"default": "[\n null\n]",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Filters",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ JSON.parse($value) }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Put"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Headers",
|
|
"name": "Headers",
|
|
"type": "json",
|
|
"default": "{}",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Headers",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ JSON.parse($value) }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Put"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "ID",
|
|
"name": "Id",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Id",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Put"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Is Paused",
|
|
"name": "IsPaused",
|
|
"type": "boolean",
|
|
"default": true,
|
|
"routing": {
|
|
"send": {
|
|
"property": "IsPaused",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Put"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Properties",
|
|
"name": "Properties",
|
|
"type": "json",
|
|
"default": "{}",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Properties",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ JSON.parse($value) }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Put"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"required": true,
|
|
"displayName": "Secret",
|
|
"name": "Secret",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Secret",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Put"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"required": true,
|
|
"displayName": "Web Hook Uri",
|
|
"name": "WebHookUri",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "WebHookUri",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Webhooks"
|
|
],
|
|
"operation": [
|
|
"Web Hook Management Put"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
];
|