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}

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

Namespace Global

    Namespace Field2Office.API.Model.Integration

        '''<Summary>
        '''Catch a web hook request and execute a workflow.
        '''</Summary>
        Public Partial Class Hook
            Public Overridable Property Workspace As String
            Public Overridable Property RuleId As String
            Public Overridable Property RequestStream As Stream
        End Class
    End Namespace
End Namespace

VB.NET 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
}