API call to have a user watch specific category(ies)?

dev
1

According to a reply by @Falco on my post, there’s a way to set users to watch categories using the API. I’ve spent hours searching the web and combing through the API documentation but I cannot find this call.

Does anyone know what API call could be used to set a user to watch a specific category?

Thank you.

2

You can search for "reverse engineer api " for tips on how to figure out the API call. Also, there is a plugin that will make people in a certain group follow a set of categories.

3

Thanks for the reply @pfaffman. Are you suggesting the API documentation is incomplete and I need to reverse engineer the API code to find the undocumented API call?

4

if you don’t see what you’re looking for, it’s almost as easy to reverse engineer as use the documentation.

1 Like
5

Have you figured out how to achieve this?

Here is how to do it using jQuery Ajax for anyone interested:

const data = {
	notification_level: 3, 
	api_key: "all_users_api_key",
	api_username: "target_user_username"
};

const settings = {
  url: "/category/{{category_id}}/notifications",
  method: "POST",
  data: data
};

$.ajax(settings).done(response => {
  console.log(response);
});
4 Likes
6

I’m sure @Osama’s method works, but setting user watches via the category seemed a bit weird to me. The following sets the watch list directly against the user (This is via python requests, but shows what is required).

DISCOURSE_URL - domain, including http(s)
username - user to change
DISCOURSE_API_KEY - api key generated by, and associated with a user
DISCOURSE_API_USERNAME - user who the key is associated with
watch_category - a list of categories the user should be watching

requests.request(‘PUT’, ‘{0}/u/{1}.json’.format(DISCOURSE_URL, username), allow_redirects=False, params={“api_key”:DISCOURSE_API_KEY, “api_username”: DISCOURSE_API_USERNAME}, json={‘watched_category_ids’: [watch_category]}, headers={‘Accept’: ‘application/json; charset=utf-8’})

@SwisherSweet if you end up opening a bug against the docs for missing info on how to modify the watch list/user prefs do post back here with it.

7

I’m not sure if this code can accomplish what I’m looking to do, but…

I’d like to add a hyperlink that would have some kind of URL parameter that when a user clicked the link, they would be Watching/Tracking/Normal/Muted for a particular category.

Practical use case would be instead of me telling folks to Visit the category… and click the bell icon and choose _____… I could say something like…

CLICK HERE if you want to be notified whenever a new post is added to this forum.

Then, when the users clicks that hyperlink, they are subscribed at the level we define, in the url parameter.

8

I think this would be relatively straightforward to write as a plugin or theme component, some kind of embeddable entity which can make these actions for you. The issue with the AJAX code posted above is that you are sending the global all users API key to the client. This is totally a bad idea.

The issue you will have with creating a link, as per the OP, is that the API call requires a REST POST action and links can only issue a REST GET action.

1 Like