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 'package:servicestack/servicestack.dart';

/**
* Catch a web hook request and execute a workflow.
*/
class Hook implements IConvertible
{
    String? Workspace;
    String? RuleId;
    Uint8List? RequestStream;

    Hook({this.Workspace,this.RuleId,this.RequestStream});
    Hook.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Workspace = json['Workspace'];
        RuleId = json['RuleId'];
        RequestStream = JsonConverters.fromJson(json['RequestStream'],'Uint8List',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Workspace': Workspace,
        'RuleId': RuleId,
        'RequestStream': JsonConverters.toJson(RequestStream,'Uint8List',context!)
    };

    getTypeName() => "Hook";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'dev.fieldsquared.com', types: <String, TypeInfo> {
    'Hook': TypeInfo(TypeOf.Class, create:() => Hook()),
    'Uint8List': TypeInfo(TypeOf.Class, create:() => Uint8List(0)),
});

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