NSWebhook - SuperOffice

nWebhook definitions. Webhooks broadcast events from NetServer to remote servers.

Constructors

NSWebhook()

NSWebhook

Initializes a new instance of the NSWebhook class.

Methods

GetErrorsEmail()

Email address to send error message to when this webhook state changes to too-many errors.

String[] GetErrorsEmail()

Returns: CRMScript.Global.String[] - The email address error messages are sent to when this webhook state changes to too-many errors.

Only one email address.

Example:

NSWebhook webhook;
String emailAddress = webhook.GetErrorsEmail();

GetEvents()

String[] GetEvents()

Returns: CRMScript.Global.String[] - Array of event names that trigger this webhook [‘contact.created’, ‘sale.changed’] Example:

NSWebhook thing;
String[] events = thing.GetEvents();

GetHeaders()

Map GetHeaders()

Returns: CRMScript.Native.Map - Custom HTTP Headers to add to webhook requests. Example:

NSWebhook thing;
Map headers = thing.GetHeaders();

GetName()

String GetName()

Returns: CRMScript.Global.String - Name to identify this webhook. Does not have to be unique. Example:

NSWebhook thing;
String name = thing.GetName();

GetProperties()

StringObjectDictionary GetProperties()

Returns: CRMScript.Native.StringObjectDictionary - Custom values to inject into JSON body of webhook call. Example:

NSWebhook thing;
StringObjectDictionary properties = thing.GetProperties();

GetRegistered()

DateTime GetRegistered()

Returns: CRMScript.Global.DateTime - Registered when. Example:

NSWebhook thing;
DateTime registered = thing.GetRegistered();

GetRegisteredAssociate()

NSAssociate GetRegisteredAssociate()

Returns: CRMScript.NetServer.NSAssociate - The user that created the webhook. Example:

NSWebhook thing;
NSAssociate registeredAssociate = thing.GetRegisteredAssociate();

GetSecret()

String GetSecret()

Returns: CRMScript.Global.String - Shared secret key used for generating SHA256 HMAC signature, so that receiver can verify that call came from this server. Example:

NSWebhook thing;
String secret = thing.GetSecret();

GetState()

Integer GetState()

Returns: CRMScript.Global.Integer - Webhook status, should we post events to the URL? See <xref href=“CRMScript.NetServer.WebhookState” data-throw-if-not-resolved=“false”></xref>. Example:

NSWebhook thing;
Integer state = thing.GetState();

GetTargetUrl()

String GetTargetUrl()

Returns: CRMScript.Global.String - Destination to POST event info to. URL for webhooks. ID for CRM scripts. Example:

NSWebhook thing;
String targetUrl = thing.GetTargetUrl();

GetType()

String GetType()

Returns: CRMScript.Global.String - Name of plugin that handles this webhook. ‘webhook’ for webhooks, which are handled by the system plugin. Example:

NSWebhook thing;
String type = thing.GetType();

GetUpdated()

DateTime GetUpdated()

Returns: CRMScript.Global.DateTime - Last updated when. Example:

NSWebhook thing;
DateTime updated = thing.GetUpdated();

GetUpdatedAssociate()

NSAssociate GetUpdatedAssociate()

Returns: CRMScript.NetServer.NSAssociate - The user that last updated the webhook. Example:

NSWebhook thing;
NSAssociate updatedAssociate = thing.GetUpdatedAssociate();

GetWebhookId()

Integer GetWebhookId()

Returns: CRMScript.Global.Integer - Primary Key. Unique id for this webhook. Example:

NSWebhook thing;
Integer webhookId = thing.GetWebhookId();

SetErrorsEmail(String)

Email address to send error message to when this webhook state changes to too-many errors.

Void SetErrorsEmail(String emailAddress)

Returns: CRMScript.Global.Void

Only one email address.

Example:

NSWebhook webhook;
webhook.SetErrorsEmail('your@email.com');

SetEvents(String[])

Void SetEvents(String[] events)

Returns: CRMScript.Global.Void Example:

NSWebhook thing;
String[] events;
thing.SetEvents(events);

SetHeaders(Map)

Void SetHeaders(Map headers)

Returns: CRMScript.Global.Void Example:

NSWebhook thing;
Map headers;
thing.SetHeaders(headers);

SetName(String)

Void SetName(String name)

Returns: CRMScript.Global.Void Example:

NSWebhook thing;
String name;
thing.SetName(name);

SetProperties(StringObjectDictionary)

Void SetProperties(StringObjectDictionary properties)

Returns: CRMScript.Global.Void Example:

NSWebhook thing;
StringObjectDictionary properties;
properties.insertInteger("foobar", 42);
thing.SetProperties(properties);

SetRegistered(DateTime)

Void SetRegistered(DateTime registered)

Returns: CRMScript.Global.Void Example:

NSWebhook thing;
DateTime registered;
thing.SetRegistered(registered);

SetRegisteredAssociate(NSAssociate)

Void SetRegisteredAssociate(NSAssociate registeredAssociate)

Returns: CRMScript.Global.Void Example:

NSWebhook thing;
NSAssociate registeredAssociate;
thing.SetRegisteredAssociate(registeredAssociate);

SetSecret(String)

Void SetSecret(String secret)

Returns: CRMScript.Global.Void Example:

NSWebhook thing;
String secret;
thing.SetSecret(secret);

SetState(Integer)

Void SetState(Integer state)

Returns: CRMScript.Global.Void Example:

NSWebhook thing;
Integer state;
thing.SetState(state);

SetTargetUrl(String)

Void SetTargetUrl(String targetUrl)

Returns: CRMScript.Global.Void Example:

NSWebhook thing;
String targetUrl;
thing.SetTargetUrl(targetUrl);

SetType(String)

Void SetType(String type)

Returns: CRMScript.Global.Void Example:

NSWebhook thing;
String type;
thing.SetType(type);

SetUpdated(DateTime)

Void SetUpdated(DateTime updated)

Returns: CRMScript.Global.Void Example:

NSWebhook thing;
DateTime updated;
thing.SetUpdated(updated);

SetUpdatedAssociate(NSAssociate)

Void SetUpdatedAssociate(NSAssociate updatedAssociate)

Returns: CRMScript.Global.Void Example:

NSWebhook thing;
NSAssociate updatedAssociate;
thing.SetUpdatedAssociate(updatedAssociate);

SetWebhookId(Integer)

Void SetWebhookId(Integer webhookId)

Returns: CRMScript.Global.Void Example:

NSWebhook thing;
Integer webhookId;
thing.SetWebhookId(webhookId);

​Constructors

​NSWebhook()

​Methods

​GetErrorsEmail()

​GetEvents()

​GetHeaders()

​GetName()

​GetProperties()

​GetRegistered()

​GetRegisteredAssociate()

​GetSecret()

​GetState()

​GetTargetUrl()

​GetType()

​GetUpdated()

​GetUpdatedAssociate()

​GetWebhookId()

​SetErrorsEmail(String)

​SetEvents(String[])

​SetHeaders(Map)

​SetName(String)

​SetProperties(StringObjectDictionary)

​SetRegistered(DateTime)

​SetRegisteredAssociate(NSAssociate)

​SetSecret(String)

​SetState(Integer)

​SetTargetUrl(String)

​SetType(String)

​SetUpdated(DateTime)

​SetUpdatedAssociate(NSAssociate)

​SetWebhookId(Integer)

Constructors

NSWebhook()

Methods

GetErrorsEmail()

GetEvents()

GetHeaders()

GetName()

GetProperties()

GetRegistered()

GetRegisteredAssociate()

GetSecret()

GetState()

GetTargetUrl()

GetType()

GetUpdated()

GetUpdatedAssociate()

GetWebhookId()

SetErrorsEmail(String)

SetEvents(String[])

SetHeaders(Map)

SetName(String)

SetProperties(StringObjectDictionary)

SetRegistered(DateTime)

SetRegisteredAssociate(NSAssociate)

SetSecret(String)

SetState(Integer)

SetTargetUrl(String)

SetType(String)

SetUpdated(DateTime)

SetUpdatedAssociate(NSAssociate)

SetWebhookId(Integer)