Definition

POST - 3/hooks

Create a new web hook. We will check your API key roles depending on the event used in the webhook.

Check the required role for each event to make sure your key has access to the event.

Request information

Sample:
{
  "EventName": "Respondent.Complete",
  "TargetUrl": "http://www.example.com/",
  "SurveyId": 1
}
Sample:
<NewWebhook xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <EventName>Respondent.Complete</EventName>
  <SurveyId>1</SurveyId>
  <TargetUrl>http://www.example.com/</TargetUrl>
</NewWebhook>

Response information


NameDescriptionTypeAdditional information
Meta

The metadata such as paging parameters, status code, timestamp,... which are related to this request.

MetaData

Data

The actual data returned by the request.

Webhook

Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.

Hateoas

Sample:
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2019-02-21T14:41:50.212538Z",
    "IsFiltered": true
  },
  "Data": {
    "WebhookId": 1,
    "RegisteredDate": "2019-02-21T14:41:50.212538Z",
    "SurveyId": 1,
    "EventName": "sample string 6",
    "ClientUrl": "sample string 8",
    "IsActive": true,
    "SurveyTitle": "sample string 10"
  }
}
Sample:
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data z:Id="i2">
    <ClientUrl>sample string 8</ClientUrl>
    <EventName>sample string 6</EventName>
    <IsActive>true</IsActive>
    <RegisteredDate>2019-02-21T14:41:50.212538+00:00</RegisteredDate>
    <SurveyId>1</SurveyId>
    <SurveyTitle>sample string 10</SurveyTitle>
    <WebhookId>1</WebhookId>
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2019-02-21T14:41:50.212538+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>