POST api/webhooks/registrations

Request Information

URI Parameters

None.

Body Parameters

WebHook
NameDescriptionTypeAdditional information
Id

string

None.

WebHookUri

URI

Required

Secret

string

None.

Description

string

None.

IsPaused

boolean

None.

Filters

Collection of string

None.

Headers

Dictionary of string [key] and string [value]

None.

Properties

Dictionary of string [key] and Object [value]

None.

Request Formats

application/json, text/json

Sample:
{
  "id": "sample string 1",
  "webHookUri": "http://webapihelppage2.com",
  "secret": "sample string 3",
  "description": "sample string 4",
  "isPaused": true,
  "filters": [],
  "headers": {},
  "properties": {}
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

WebHook
NameDescriptionTypeAdditional information
Id

string

None.

WebHookUri

URI

Required

Secret

string

None.

Description

string

None.

IsPaused

boolean

None.

Filters

Collection of string

None.

Headers

Dictionary of string [key] and string [value]

None.

Properties

Dictionary of string [key] and Object [value]

None.

Response Formats

application/json, text/json

Sample:
{
  "id": "sample string 1",
  "webHookUri": "http://webapihelppage2.com",
  "secret": "sample string 3",
  "description": "sample string 4",
  "isPaused": true,
  "filters": [],
  "headers": {},
  "properties": {}
}