logo

Back to Help Home Page.

PUT Api/Webhooks

Updates the specified webHook.

Request Information

URI Parameters

None.

Body Parameters

The webhook to update.

ChappReport.Site.Areas.Api.Models.V1.WebhookV1ModelRequest
NameDescriptionTypeAdditional information

Label

The label of the webhook. Possible value: OnFlowStatusChange

string

Required

Url

The url of the webhook for Chapps to call. This url will be enriched with following parameters: reportId and flowStatus.

string

Required

Max length: 100

Min length: 10

Credentials

The credentials to be used while calling the url.

ChappReport.Site.Areas.Api.Models.V1.Credentials

None.

Headers

The Headers to be add while calling the url.

Collection of Pair of string [key] and string [value]

None.

Request Formats

application/json, text/json

Sample:
{
  "Label": "sample string 1",
  "Url": "sample string 2",
  "Credentials": {
    "Username": "sample string 1",
    "Password": "sample string 2"
  },
  "Headers": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<WebhookV1ModelRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ChappReport.Site.Areas.Api.Models.V1">
  <Credentials>
    <Password>sample string 2</Password>
    <Username>sample string 1</Username>
  </Credentials>
  <Headers xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
  </Headers>
  <Label>sample string 1</Label>
  <Url>sample string 2</Url>
</WebhookV1ModelRequest>

Response Information

Resource Description

None.