PUT 3/hooks/{WebhookId}/deactivate

Definition

PUT - 3/hooks/{WebhookId}/deactivate

Deactivate your webhook. You won't receive any request anymore. But the webhook ID and key will remain the same for Activation in the future.

Request information

Uri parameters

Name	Description	Type	Additional information
WebhookId The identifier of the webhook to activate. Type integer Additional info Required
WebhookId	The identifier of the webhook to activate.	integer	Required

Response information

Response body fields

Name	Description	Type
Meta The metadata such as paging parameters, status code, timestamp,... which are related to this request. Type MetaData
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. Type Webhook
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. Type Hateoas
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

Note about API metadata
The API uses the same metadata structure for all endpoints, but not every field applies to every endpoint. Fields such as paging details (for example Limit, Offset and TotalRowCount) and IsFiltered are only returned by endpoints that support them. Fields that do not apply are not included in the actual response.

JSON
XML

Sample:

{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2026-11-13T20:04:48.7806117Z",
    "IsFiltered": true
  },
  "Data": {
    "WebhookId": 1,
    "RegisteredDate": "2026-11-13T20:04:48.7806117Z",
    "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>2026-11-13T20:04:48.7806117+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>2026-11-13T20:04:48.7806117+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>

Definition