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}
namespace Field2Office.API.Model.Integration

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Catch a web hook request and execute a workflow.
    ///</summary>
    [<AllowNullLiteral>]
    type Hook() = 
        member val Workspace:String = null with get,set
        member val RuleId:String = null with get,set
        member val RequestStream:Stream = null with get,set

F# 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
}