System APIs

PUT system/webhooks/{webhookId}

Update provided webhook

HTTP method	PUT
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	275, version 16

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:

<Webhook

Webhook

This field is optional.

<Name

Name

Name of webhook

This field is optional.

>{String}</Name>

<Format

Format

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

Applicable domain values can be found here

This field is optional.

>{String}</Format>

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

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

<ExclusivelyForCompany

ExclusivelyForCompany

Company this webhook belongs to

This field is optional.

<CompanyId

CompanyId

Company identifier

Minimum value: 100

This field is optional.

>{Integer}</CompanyId>

                                             </ExclusivelyForCompany>
                                    

<RamBaseEventType

RamBaseEventType

This field is optional.

<RamBaseEventTypeId

RamBaseEventTypeId

RamBase event type identifier

Minimum value: 100000

This field is optional.

>{Integer}</RamBaseEventTypeId>

                                             </RamBaseEventType>
                                    

<MessageAuthentication

MessageAuthentication

This field is optional.

<SecretToken

SecretToken

Secret token used to sign the webhook

This field is optional.

>{String}</SecretToken>

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

                                             </MessageAuthentication>
                                    

                                        </Webhook>
                                    

{

"webhook

Webhook

This field is optional.

": {

"name

Name

Name of webhook

This field is optional.

": "{String}",

"format

Format

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

Applicable domain values can be found here

This field is optional.

": "{String}",

"parameterFilter

ParameterFilter

This field is optional.

": "{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

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

This field is optional.

": "{String}",

"exclusivelyForCompany

ExclusivelyForCompany

Company this webhook belongs to

This field is optional.

": {

"companyId

CompanyId

Company identifier

Minimum value: 100

This field is optional.

": "{Integer}"

},

"ramBaseEventType

RamBaseEventType

This field is optional.

": {

"ramBaseEventTypeId

RamBaseEventTypeId

RamBase event type identifier

Minimum value: 100000

This field is optional.

": "{Integer}"

},

"messageAuthentication

MessageAuthentication

This field is optional.

": {

"secretToken

SecretToken

Secret token used to sign the webhook

This field is optional.

": "{String}",

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

}

}

}

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.

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:

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