1. v3
  2. Hooks
  3. POST - 3/hooks/{webhookid}/activate

Definition

POST - 3/hooks/{WebhookId}/activate

Activate your webhook. Activation is required before you will receive requests. This flow is required to improve security.

Important: when activating your webhook you need to pass the X-Hook-Key header.

Request information

WebhookId

The identifier of the webhook to activate.


Type integer
Additional info
Required

Response information


Meta

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


Type MetaData
Data

The actual data returned by the request.


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


Type Hateoas

Sample: 
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2024-12-30T16:13:57.4790154Z",
    "IsFiltered": true
  },
  "Data": {
    "WebhookId": 1,
    "RegisteredDate": "2024-12-30T16:13:57.4790154Z",
    "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>2024-12-30T16:13:57.4790154+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>2024-12-30T16:13:57.4790154+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>