Webhook Endpoint Resource Node

The HTTP Endpoint Resource is a resource that exposes a function via a RESTful API. This makes it possible to trigger workflows on Dynaboard from other services.

Properties

Route Override

ProphttpEndpointNode.route
Typestring
Defaultundefined

The route where the endpoint should be mounted, relative to the project's endpoints root URL. Supports all routes supported by express via path-to-regexp.

Test Method

ProphttpEndpointNode.testMethod
Typestring
DefaultGET

The HTTP method to use for test requests.

Test Request Headers

ProphttpEndpointNode.testHeaders
TypeArray<{ key: string, value: string }>
Default[]

The header values to be used for test requests on this endpoint.

Test Body

ProphttpEndpointNode.testBody
Typestring
Defaultundefined

The body value to be used for test requests on this endpoint.

Event Handlers

On Request

HandlerhttpEndpointNode.onRequest

The project function to call when the HTTP endpoint receives a request.