API

System APIs

GET system/webhooks/{webhookId}

Webhook details for provided identifier

HTTP method GET
URI https://api.rambase.net/system/webhooks/{webhookId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {webhookId} Webhook identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 2372, version 17

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
1

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.

$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]
$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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.

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. Fields colored in grey is expandable 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
     </MessageAuthentication>
23
     <Repository
Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>
24
          <Scope
Scope

Scope of the Duty

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

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

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

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

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

EmployeeId of the employee making the change

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>
27
               <UserId
UserId

User identifier

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

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

User reference

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>{String}</UserLink>
29
          </ChangedBy>
30
          <IsPendingDeployment
IsPendingDeployment

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

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>{Boolean}</IsPendingDeployment>
31
     </Repository>
32
</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
          },
24
          "repository
Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": {
25
               "scope
Scope

Scope of the Duty

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

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

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

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

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

EmployeeId of the employee making the change

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": {
28
                    "userId
UserId

User identifier

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

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

User reference

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": "{String}"
30
               },
31
               "isPendingDeployment
IsPendingDeployment

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

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": "{Boolean}"
32
          }
33
     }
34
}

Possible error codes the response might return:

Error 101566 HTTP 404 User not found