Field Squared API Services

<back to all web services

Hook

Catch a web hook request and execute a workflow.

The following routes are available for this service:
GET/{Workspace}/Hook/Catch/{RuleId}
POST/{Workspace}/Hook/Catch/{RuleId}

/** @description Catch a web hook request and execute a workflow. */
export class Hook
{
    public Workspace: string;
    public RuleId: string;
    public RequestStream: string;

    public constructor(init?: Partial<Hook>) { (Object as any).assign(this, init); }
}

TypeScript Hook DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /{Workspace}/Hook/Catch/{RuleId} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Workspace: String,
	RuleId: String
}