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}

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Catch a web hook request and execute a workflow.
    */
    public static class Hook
    {
        public String Workspace = null;
        public String RuleId = null;
        public InputStream RequestStream = null;
        
        public String getWorkspace() { return Workspace; }
        public Hook setWorkspace(String value) { this.Workspace = value; return this; }
        public String getRuleId() { return RuleId; }
        public Hook setRuleId(String value) { this.RuleId = value; return this; }
        public InputStream getRequestStream() { return RequestStream; }
        public Hook setRequestStream(InputStream value) { this.RequestStream = value; return this; }
    }

}

Java 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>