Update Webhook REST Endpoint

Ben Tiedt — Tue, 19 Nov 2019 20:26:36 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:26:36

URLs

POST (Header: PUT) api.ashx/v2/webhooks.xml (or .json)

Request Parameters

Name	Type	Description	Location	Required
CallBackUrlId	`int`	Id of the Webhook to update	Request Body	Required
CallBackUrl	`string`	Url of the Webhook to register to	Request Body	Optional
IsEnabled	`bool`	Disabled webhooks will not recieve any event data	Request Body	Optional
RegenerateSecret	`bool`	If true, the hash verification secret token for this webhook will be regenerated.	Request Body	Optional
SubscribedWebhookIds	`string`	Comma-separated list of ids of each Webhook to register to. This will set each listed webhook as subscribed, and each not listed webhook as not subscribed.	Request Body	Optional

Example Requests

C# REST SDK

This example uses the REST SDK to access the Community REST API within a .Net C# application. In the example, USER_NAME is the user name of the effective user for the request and OAUTH_CLIENT_ID and OAUTH_SECRET are the OAuth client ID and secret, respectively, associated to this application as configured in Administration > Integration > OAuth Clients with the "Client Credentials" grant type enabled. See the documentation for the REST SDK for more details about installation, configuration, and usage options.

var host = new ClientCredentialsRestHost("USER_NAME", "https://mysite.com/", "OAUTH_CLIENT_ID", "OAUTH_SECRET");
var response = host.PutToDynamic(2, "webhooks.json", false, new RestPutOptions {
	PostParameters = new System.Collections.Specialized.NameValueCollection {
		{ "CallBackUrlId", "6" }
	}
});

Widget Javascript

This example uses the [[rest JavaScript API Module|rest JavaScript API]] to access the Community REST API within the Community web UI. When accessing the REST API through the javascript API, the effective user is the current contextual user of the web interface.

jQuery.telligent.evolution.put({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/webhooks.json',
	data: { 
		'CallBackUrlId': '6'
	},
	success: function(response) {

	}
});

cURL

This example uses the cURL command-line HTTP utility. ENCODED_TOKEN in the example is the base64-encoded concatenation of the user's API key (created from the user's profile), a colon (:), and the user's user name. Learn more about using the REST API.

curl -H "Rest-User-Token: ENCODED_TOKEN" -d "CallBackUrlId=6" -H "Rest-Method: PUT" -X POST https://mysite.com/api.ashx/v2/webhooks.xml

Example Responses

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <Webhook>
    <Url>url</Url>
    <Id>6</Id>
    <IsEnabled>true</IsEnabled>
    <Events PageSize="2" PageIndex="0" TotalCount="2">
      <RestWebhookEvent>
        <Name>name</Name>
        <Description>description</Description>
        <Id>49fec544-6df7-4a82-872b-f8be586d5e9e</Id>
        <MessageType>messagetype</MessageType>
      </RestWebhookEvent>
      <RestWebhookEvent>
        <Name>name</Name>
        <Description>description</Description>
        <Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id>
        <MessageType>messagetype</MessageType>
      </RestWebhookEvent>
    </Events>
  </Webhook>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
</Response>

JSON

{
  "Webhook": {
    "Url": "url",
    "Id": 6,
    "IsEnabled": true,
    "Events": [
      {
        "Name": "name",
        "Description": "description",
        "Id": "49fec544-6df7-4a82-872b-f8be586d5e9e",
        "MessageType": "messagetype"
      },
      {
        "Name": "name",
        "Description": "description",
        "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
        "MessageType": "messagetype"
      }
    ]
  },
  "Errors": [
    "string",
    "string"
  ]
}