System APIs

GET system/webhooks

This resource returns a list of WebHooks

HTTP method	GET
URI	https://api.rambase.net/system/webhooks
Supported formats	Xml, Html, Json (ex. $format=json)
Maximum page size ($top)	200
Successful HTTP status code	200
API resource identifier	274, version 24

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:

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
$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.
$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.
$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.
$format String, optional	Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional	Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional	Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional	Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional	Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional	Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

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

Active() Named filter	Active webhooks (status eq 4)
NewAndActive() Named filter	New and active webhooks (status 1 and 4)
ChangedBy Integer	User identifier.
Format String	Format or response type for the webhook (XML / JSON).
IsChanged Boolean	Tells whether this object has been changed locally and are ready to be committed to the Repository.
IsPendingDeployment Boolean	Tells whether this object has been changed locally and is ready to be deployed from the Repository.
Name String	Key of the Event Type. This key will be used to identify which event to fire.
RamBaseEventTypeName String	Key of the Event Type. This key will be used to identify which event to fire.
Scope String	Scope of the Duty.
Status Integer	Status of the webhook. Webhooks in ST:4 is considered to be active.
TargetUrl String	Target url for POSTing , to which to POST data to. Must include protocol (http:// or https://). Example: http://client.example.com/example-webhook.
WebhookId Integer	Webhook identifier.

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

ChangedBy Integer	User identifier
Format String	Format or response type for the webhook (XML / JSON).
IsChanged Boolean	Tells whether this object has been changed locally and are ready to be committed to the Repository
IsPendingDeployment Boolean	Tells whether this object has been changed locally and is ready to be deployed from the Repository
Name String	Key of the Event Type. This key will be used to identify which event to fire.
RamBaseEventTypeName String	Key of the Event Type. This key will be used to identify which event to fire.
Scope String	Scope of the Duty
Status Integer	Status of the webhook. Webhooks in ST:4 is considered to be active.
TargetUrl String	Target url for POSTing , to which to POST data to. Must include protocol (http:// or https://). Example: http://client.example.com/example-webhook
WebhookId Integer	Webhook identifier

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:

                                        <Webhooks>
                                    

                                             <Webhook>
                                    

<WebhookId

WebhookId

Webhook identifier

>{Integer}</WebhookId>

<Status

Status

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

>{Integer}</Status>

<Name

Name

Name of webhook

>{String}</Name>

<Format

Format

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

Possible domain values can be found here

>{String}</Format>

<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>

<ExclusivelyForCompany

ExclusivelyForCompany

Company this webhook belongs to

<CompanyId

CompanyId

Company identifier

>{Integer}</CompanyId>

<Database

Database

Abbreviation/code to identify the company

>{String}</Database>

<CompanyLink

CompanyLink

Company reference

>{String}</CompanyLink>

                                                  </ExclusivelyForCompany>
                                    

                                                  <RamBaseEventType>
                                    

<RamBaseEventTypeId

RamBaseEventTypeId

RamBase event type identifier

>{Integer}</RamBaseEventTypeId>

<Name

Name

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

>{String}</Name>

<RamBaseEventTypeLink

RamBaseEventTypeLink

RamBase event type reference

>{String}</RamBaseEventTypeLink>

                                                  </RamBaseEventType>
                                    

<WebhookLink

WebhookLink

Webhook reference

>{String}</WebhookLink>

                                             </Webhook>
                                    

<Paging

Paging

Detailed paging information for this list.

<PageSize

PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>

<Position

Position

Position of the first element in the list

>{Integer}</Position>

<Page

Page

Page index

>{Integer}</Page>

<FirstPageKey

FirstPageKey

Page key to use for navigating to the first page in the list

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

>{String}</FirstPageKey>

<FirstPage

FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>

<PreviousPageKey

PreviousPageKey

Page key to use for navigating to previous page in the list

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

>{String}</PreviousPageKey>

<PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>

<NextPageKey

NextPageKey

Page key to use for navigating to next page in the list

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

>{String}</NextPageKey>

<NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>

<LastPageKey

LastPageKey

Page key to use for navigating to last page in the list

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

>{String}</LastPageKey>

<LastPage

LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>

<Size

Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>

                                             </Paging>
                                    

                                        </Webhooks>
                                    

{

                                             "webhooks": [
                                    

{

"webhookId

WebhookId

Webhook identifier

": "{Integer}",

"status

Status

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

": "{Integer}",

"name

Name

Name of webhook

": "{String}",

"format

Format

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

Possible domain values can be found here

": "{String}",

"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}",

"exclusivelyForCompany

ExclusivelyForCompany

Company this webhook belongs to

": {

"companyId

CompanyId

Company identifier

": "{Integer}",

"database

Database

Abbreviation/code to identify the company

": "{String}",

"companyLink

CompanyLink

Company reference

": "{String}"

},

                                                       "ramBaseEventType": {
                                    

"ramBaseEventTypeId

RamBaseEventTypeId

RamBase event type identifier

": "{Integer}",

"name

Name

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

": "{String}",

"ramBaseEventTypeLink

RamBaseEventTypeLink

RamBase event type reference

": "{String}"

},

"webhookLink

WebhookLink

Webhook reference

": "{String}"

}

],

"paging

Paging

Detailed paging information for this list.

": {

"pageSize

PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",

"position

Position

Position of the first element in the list

": "{Integer}",

"page

Page

Page index

": "{Integer}",

"firstPageKey

FirstPageKey

Page key to use for navigating to the first page in the list

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

": "{String}",

"firstPage

FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",

"previousPageKey

PreviousPageKey

Page key to use for navigating to previous page in the list

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

": "{String}",

"previousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",

"nextPageKey

NextPageKey

Page key to use for navigating to next page in the list

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

": "{String}",

"nextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",

"lastPageKey

LastPageKey

Page key to use for navigating to last page in the list

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

": "{String}",

"lastPage

LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",

"size

Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"

}

}

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 101566 HTTP 404

User not found