API

System APIs

POST system/webhooks

Create a new webhook

HTTP method POST
URI https://api.rambase.net/system/webhooks
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 271, version 15

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<Webhook>
2
     <Name
Name

Required/mandatory field

Name of webhook

>{String}</Name>
3
     <Format
Format

Format or response type for the webhook (XML / JSON).

Applicable domain values can be found here

Default value: JSON

This field is optional.

>{String}</Format>
4
     <ParameterFilter
ParameterFilter

Filter for parameters. Contains one or more expressions. Expressions are in the syntax: parametername operator value. Parametername must be in brackets (ex [SalesOrderId]). Supported operators are '=' and '!='. Value must be inside single quotes.. Several expressions can be combined with AND or OR.

This field is optional.

>{String}</ParameterFilter>
5
     <TargetUrl
TargetUrl

Target url for POSTing , to which to POST data to. Must include protocol (http:// or https://). Example: http://client.example.com/example-webhook

Input must match the following regular expression pattern: ^(http|https):\/\/[\w\-_]+(\.[\w\-_]+)+([\w\-\.,@?^=%&:/~\+#]*[\w\-\@?^=%&/~\+#])?$

This field is optional.

>{String}</TargetUrl>
6
     <ExclusivelyForCompany
ExclusivelyForCompany

Company this webhook belongs to

This field is optional.

>
7
          <CompanyId
CompanyId

Company identifier

Minimum value: 100

This field is optional.

>{Integer}</CompanyId>
8
     </ExclusivelyForCompany>
9
     <RamBaseEventType>
10
          <RamBaseEventTypeId
RamBaseEventTypeId

Required/mandatory field

RamBase event type identifier

Minimum value: 100000

>{Integer}</RamBaseEventTypeId>
11
     </RamBaseEventType>
12
     <MessageAuthentication
MessageAuthentication

This field is optional.

>
13
          <SecretToken
SecretToken

Secret token used to sign the webhook

This field is optional.

>{String}</SecretToken>
14
          <HashFunction
HashFunction

Hash function used to generate the signature used to sign the webhook

Applicable domain values can be found here

This field is optional.

>{String}</HashFunction>
15
     </MessageAuthentication>
16
</Webhook>
1
{
2
     "webhook": {
3
          "name
Name

Required/mandatory field

Name of webhook

": "{String}",
4
          "format
Format

Format or response type for the webhook (XML / JSON).

Applicable domain values can be found here

Default value: JSON

This field is optional.

": "{String}",
5
          "parameterFilter
ParameterFilter

Filter for parameters. Contains one or more expressions. Expressions are in the syntax: parametername operator value. Parametername must be in brackets (ex [SalesOrderId]). Supported operators are '=' and '!='. Value must be inside single quotes.. Several expressions can be combined with AND or OR.

This field is optional.

": "{String}",
6
          "targetUrl
TargetUrl

Target url for POSTing , to which to POST data to. Must include protocol (http:// or https://). Example: http://client.example.com/example-webhook

Input must match the following regular expression pattern: ^(http|https):\/\/[\w\-_]+(\.[\w\-_]+)+([\w\-\.,@?^=%&:/~\+#]*[\w\-\@?^=%&/~\+#])?$

This field is optional.

": "{String}",
7
          "exclusivelyForCompany
ExclusivelyForCompany

Company this webhook belongs to

This field is optional.

": {
8
               "companyId
CompanyId

Company identifier

Minimum value: 100

This field is optional.

": "{Integer}"
9
          },
10
          "ramBaseEventType": {
11
               "ramBaseEventTypeId
RamBaseEventTypeId

Required/mandatory field

RamBase event type identifier

Minimum value: 100000

": "{Integer}"
12
          },
13
          "messageAuthentication
MessageAuthentication

This field is optional.

": {
14
               "secretToken
SecretToken

Secret token used to sign the webhook

This field is optional.

": "{String}",
15
               "hashFunction
HashFunction

Hash function used to generate the signature used to sign the webhook

Applicable domain values can be found here

This field is optional.

": "{String}"
16
          }
17
     }
18
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Webhook>
2
     <WebhookId
WebhookId

Webhook identifier

>{Integer}</WebhookId>
3
     <Status
Status

Status of the webhook. Webhooks in ST:4 is considered to be active.

>{Integer}</Status>
4
     <Name
Name

Name of webhook

>{String}</Name>
5
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
6
     <Format
Format

Format or response type for the webhook (XML / JSON).

Possible domain values can be found here

>{String}</Format>
7
     <ParameterFilter
ParameterFilter

Filter for parameters. Contains one or more expressions. Expressions are in the syntax: parametername operator value. Parametername must be in brackets (ex [SalesOrderId]). Supported operators are '=' and '!='. Value must be inside single quotes.. Several expressions can be combined with AND or OR.

>{String}</ParameterFilter>
8
     <TargetUrl
TargetUrl

Target url for POSTing , to which to POST data to. Must include protocol (http:// or https://). Example: http://client.example.com/example-webhook

>{String}</TargetUrl>
9
     <ExclusivelyForCompany
ExclusivelyForCompany

Company this webhook belongs to

>
10
          <CompanyId
CompanyId

Company identifier

>{Integer}</CompanyId>
11
          <Database
Database

Abbreviation/code to identify the company

>{String}</Database>
12
          <CompanyLink
CompanyLink

Company reference

>{String}</CompanyLink>
13
     </ExclusivelyForCompany>
14
     <RamBaseEventType>
15
          <RamBaseEventTypeId
RamBaseEventTypeId

RamBase event type identifier

>{Integer}</RamBaseEventTypeId>
16
          <Name
Name

Key of the Event Type. This key will be used to identify which event to fire.

>{String}</Name>
17
          <RamBaseEventTypeLink
RamBaseEventTypeLink

RamBase event type reference

>{String}</RamBaseEventTypeLink>
18
     </RamBaseEventType>
19
     <MessageAuthentication>
20
          <SecretToken
SecretToken

Secret token used to sign the webhook

>{String}</SecretToken>
21
          <HashFunction
HashFunction

Hash function used to generate the signature used to sign the webhook

Possible domain values can be found here

>{String}</HashFunction>
22
          <Scope
Scope

Scope of the Duty

>{String}</Scope>
23
          <IsChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

>{Boolean}</IsChanged>
24
          <ChangedBy
ChangedBy

EmployeeId of the employee making the change

>
25
               <UserId
UserId

User identifier

>{Integer}</UserId>
26
               <UserLink
UserLink

User reference

>{String}</UserLink>
27
          </ChangedBy>
28
          <IsPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

>{Boolean}</IsPendingDeployment>
29
     </MessageAuthentication>
30
</Webhook>
1
{
2
     "webhook": {
3
          "webhookId
WebhookId

Webhook identifier

": "{Integer}",
4
          "status
Status

Status of the webhook. Webhooks in ST:4 is considered to be active.

": "{Integer}",
5
          "name
Name

Name of webhook

": "{String}",
6
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
7
          "format
Format

Format or response type for the webhook (XML / JSON).

Possible domain values can be found here

": "{String}",
8
          "parameterFilter
ParameterFilter

Filter for parameters. Contains one or more expressions. Expressions are in the syntax: parametername operator value. Parametername must be in brackets (ex [SalesOrderId]). Supported operators are '=' and '!='. Value must be inside single quotes.. Several expressions can be combined with AND or OR.

": "{String}",
9
          "targetUrl
TargetUrl

Target url for POSTing , to which to POST data to. Must include protocol (http:// or https://). Example: http://client.example.com/example-webhook

": "{String}",
10
          "exclusivelyForCompany
ExclusivelyForCompany

Company this webhook belongs to

": {
11
               "companyId
CompanyId

Company identifier

": "{Integer}",
12
               "database
Database

Abbreviation/code to identify the company

": "{String}",
13
               "companyLink
CompanyLink

Company reference

": "{String}"
14
          },
15
          "ramBaseEventType": {
16
               "ramBaseEventTypeId
RamBaseEventTypeId

RamBase event type identifier

": "{Integer}",
17
               "name
Name

Key of the Event Type. This key will be used to identify which event to fire.

": "{String}",
18
               "ramBaseEventTypeLink
RamBaseEventTypeLink

RamBase event type reference

": "{String}"
19
          },
20
          "messageAuthentication": {
21
               "secretToken
SecretToken

Secret token used to sign the webhook

": "{String}",
22
               "hashFunction
HashFunction

Hash function used to generate the signature used to sign the webhook

Possible domain values can be found here

": "{String}",
23
               "scope
Scope

Scope of the Duty

": "{String}",
24
               "isChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

": "{Boolean}",
25
               "changedBy
ChangedBy

EmployeeId of the employee making the change

": {
26
                    "userId
UserId

User identifier

": "{Integer}",
27
                    "userLink
UserLink

User reference

": "{String}"
28
               },
29
               "isPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

": "{Boolean}"
30
          }
31
     }
32
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 101015 HTTP 404 Permission not found
Error 101420 HTTP 404 Setting definition not found