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}

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.Integration;

namespace Field2Office.API.Model.Integration
{
    ///<summary>
    ///Catch a web hook request and execute a workflow.
    ///</summary>
    public partial class Hook
    {
        public virtual string Workspace { get; set; }
        public virtual string RuleId { get; set; }
        public virtual Stream RequestStream { get; set; }
    }

}

C# 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>