Syncano

Class: ScriptEndpoint

ScriptEndpoint

new ScriptEndpoint()

OO wrapper around instance webhooks endpoint.

Properties:
Name Type Argument Default Description
name String
instanceName String
public_link String
public Boolean
codebox Number
description String <optional>
 null
links String <optional>
 {}
Source:

Methods

reset()

Resets current ScriptEndpoint.

Source:
Returns:
Type
Promise
Example
ScriptEndpoint.please().get({instanceName: 'test-one', name: 'test'}).then(function(webhook) {
        webhook.reset().then(function() {});
      });

run( [payload])

Runs current ScriptEndpoint.

Parameters:
Name Type Argument Default Description
payload Object <optional>
 {}
Source:
Returns:
Type
Promise
Example
ScriptEndpoint.please().get({instanceName: 'test-one', id: 1}).then(function(codebox) {
        codebox.run({some: 'variable'}).then(function(trace) {});
      });

runPublic( [payload])

Runs current public ScriptEndpoint.

Parameters:
Name Type Argument Default Description
payload Object <optional>
 {}
Source:
Returns:
Type
Promise
Example
ScriptEndpoint.please().get({instanceName: 'test-one', id: 1}).then(function(codebox) {
        codebox.runPublic({some: 'variable'}).then(function(trace) {});
      });