POST api/webhooks/registrations

Request Information

URI Parameters

None

Body Parameters

Webhook definition

Name	Description	Type	Additional information
WebHookUri	The url where the webhook notifications will be sent to. If the url does not contains a request parameter "noecho" a GET request is send to this url to verify it is available. The response body must match the value of the request parameter "echo" in order for the validation to pass.	string	Required.
Description	The description of the webhook.	string	None.
Filters	The list of webhook notifications you want to register to.	collection of strings	Required.
IsPaused	Indication wether the webhook is paused or not. If true, notifications are suspended for the registration.	boolean	Optional.
Properties	A set of additional case-insensitive properties that will be sent with the WebHook request as part of the HTTP request entity body	collection of key/value pairs	Optional.
Headers	A set of additional HTTP headers that will be sent with the WebHook request.	collection of key/value pairs	Optional.

Request Formats

application/json, text/json

Sample:

{
    "WebHookUri": "http://webhook.site/e3bfd439-ea9d-40be-bdae-509c4c504228?NoEcho=1",
    "Description": "Registration for ClientReport mutations",
    "Filters": 
    [
        "ClientReport"
    ],
    "Properties": 
    {
        "My Property Name": "My Property Value"
    },
    "Headers": 
    {
        "My Header Name": "My Header Value"
    }
}

Response Information

The created webhook registration.

Response Formats

application/json, text/json

Sample:

{
    "Id":"6e9beff043d345648dee2aa93df0b5ee",
    "WebHookUri": "http://webhook.site/e3bfd439-ea9d-40be-bdae-509c4c504228?NoEcho=1",
    "Description": "Registration for ClientReport mutations",
    "IsPaused":false,
    "Secret":"94024328ed01425a8504c37790748743",
    "Filters": 
    [
        "ClientReport"
    ],
    "Properties": 
    {
        "My Property Name": "My Property Value"
    },
    "Headers": 
    {
        "My Header Name": "My Header Value"
    }
}