Field Squared API 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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<Hook xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Integration">
  <RequestStream xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
  <RuleId>String</RuleId>
  <Workspace>String</Workspace>
</Hook>