NSWebhookAgent - SuperOffice

Webhook definitions* webhooks signal other systems about events inside NetServer.

Constructors

NSWebhookAgent()

NSWebhookAgent

Methods

CreateDefaultWebhook()

Sets default values into a new NSWebhook.

NSWebhook CreateDefaultWebhook()

Returns: CRMScript.NetServer.NSWebhook - A new NSWebhook with default values.

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Example:

NSWebhookAgent agent;
NSWebhook thing = agent.CreateDefaultWebhook();
thing = agent.SaveWebhook(thing);

DeleteWebhook(Integer)

Deletes the NSWebhook

DeleteWebhook(Integer webhook)

Returns: CRMScript.Global.Void Example:

NSWebhookAgent agent;
agent.DeleteWebhook(123);

GetAllWebhooks(String,String,Integer)

Returns all webhooks, according to filter criteria

NSWebhook[] GetAllWebhooks(String nameFilter, String eventFilter, Integer statusFilter)

Returns: CRMScript.NetServer.NSWebhook[] Example:

NSWebhookAgent agent;
String nameFilter;
String eventFilter;
Integer statusFilter;
NSWebhook[] res = agent.GetAllWebhooks(nameFilter, eventFilter, statusFilter);

GetLastError(Integer)

Return the most recent error message received when calling this webhook.

String GetLastError(Integer webhookId)

Returns: CRMScript.Global.String Example:

NSWebhookAgent agent;
Integer webhookId;
String res = agent.GetLastError(webhookId);

GetWebhook(Integer)

Gets an NSWebhook object.

NSWebhook GetWebhook(Integer webhookId)

Returns: CRMScript.NetServer.NSWebhook Example:

NSWebhookAgent agent;
NSWebhook thing = agent.GetWebhook(123);

SaveWebhook(NSWebhook)

Updates the existing NSWebhook or creates a new NSWebhook if the id parameter is 0

NSWebhook SaveWebhook(NSWebhook webhook)

Returns: CRMScript.NetServer.NSWebhook Example:

NSWebhook  agent;
NSWebhook thing = agent.CreateDefaultWebhook();
thing = agent.SaveWebhook(thing);

SignalEvent(String,Integer,StringObjectDictionary)

Signal webhooks that an event has occurred. All webhooks listening for the event will be notified.

Void SignalEvent(String eventName, Integer primaryKey, StringObjectDictionary data)

Returns: CRMScript.Global.Void Example:

NSWebhookAgent agent;
String eventName;
Integer primaryKey;
StringObjectDictionary data;
agent.SignalEvent(eventName, primaryKey, data);

TestWebhook(NSWebhook)

Pings a webhook with a ‘test’ event, returns SUCCESS(true) or FAILURE(false) + the response from the webhook target.

NSWebhookResult TestWebhook(NSWebhook webhook)

Returns: CRMScript.NetServer.NSWebhookResult Example:

NSWebhookAgent agent;
NSWebhook webhook;
NSWebhookResult res = agent.TestWebhook(webhook);

​Constructors

​NSWebhookAgent()

​Methods

​CreateDefaultWebhook()

​DeleteWebhook(Integer)

​GetAllWebhooks(String,String,Integer)

​GetLastError(Integer)

​GetWebhook(Integer)

​SaveWebhook(NSWebhook)

​SignalEvent(String,Integer,StringObjectDictionary)

​TestWebhook(NSWebhook)

Constructors

NSWebhookAgent()

Methods

CreateDefaultWebhook()

DeleteWebhook(Integer)

GetAllWebhooks(String,String,Integer)

GetLastError(Integer)

GetWebhook(Integer)

SaveWebhook(NSWebhook)

SignalEvent(String,Integer,StringObjectDictionary)

TestWebhook(NSWebhook)