Webhooks: how best to differentiate a PM from a public post

開発
1

Hi All,

I’ve been scrutinizing the various JSON post results from our webhooks. We record and react to public posts that contribute to our common knowledge-base differently than PMs or discobot conversations. For example, it’s relatively easy to filter out posts from discobot using its userid; likewise with system posts and topics. However, I haven’t been able to identify a reliable way to filter posts back to discobot, or PMs between two users. At first I thought only PMs had a “reply_to_user” field, but it appears that some (but not all) posts have it also. Here is an example of what we are trying to filter out:

{
"post": {
    "id": 1296,
    "name": "Test User",
    "username": "testuser",
    "avatar_template": "/letter_avatar_proxy/v2/letter/c/stringhere/{size}.png",
    "created_at": "2017-12-14T21:11:30.992Z",
    "cooked": "\u003cp\u003e[quote=\"cutlery, post:11, topic:626\"]\u003cbr\u003eIf this is coffee, please bring me some tea; but if this is tea, please bring me some coffee\u003c/p\u003e",
    "post_number": 13,
    "post_type": 1,
    "updated_at": "2017-12-14T21:11:30.992Z",
    "reply_count": 0,
    "reply_to_post_number": 11,
    "quote_count": 1,
    "avg_time": null,
    "incoming_link_count": 0,
    "reads": 1,
    "score": 0,
    "yours": false,
    "topic_id": 626,
    "topic_slug": "robot-greetings",
    "topic_title": ":robot: Greetings!",
    "display_username": "Test User",
    "primary_group_name": null,
    "primary_group_flair_url": null,
    "primary_group_flair_bg_color": null,
    "primary_group_flair_color": null,
    "version": 1,
    "user_title": null,
    "reply_to_user": {
        "username": "testuser",
        "avatar_template": "/letter_avatar_proxy/v2/letter/c/stringhere/{size}.png"
    },
    "actions_summary": [{
        "id": 2,
        "can_act": true
    }, {
        "id": 3,
        "can_act": true
    }, {
        "id": 4,
        "can_act": true
    }, {
        "id": 5,
        "hidden": true,
        "can_act": true
    }, {
        "id": 6,
        "can_act": true
    }, {
        "id": 7,
        "can_act": true
    }, {
        "id": 8,
        "can_act": true
    }],
    "moderator": false,
    "admin": false,
    "staff": false,
    "user_id": 1234,
    "hidden": false,
    "hidden_reason_id": null,
    "trust_level": 0,
    "deleted_at": null,
    "user_deleted": false,
    "edit_reason": null,
    "can_view_edit_history": true,
    "wiki": false
}
}
2

It’s messy, but if you setup both a Post and a Topic webhook. When a message, or topic is first created, both hooks will be fired. You can use the topic_id that is sent with the Post webhook to get the topic archetype from the topic webhook data. It will be set to ‘private_message’ for messages, ‘regular’ for regular topics.

It would be great to get some topic data sent with the Post webhook - category_id and archetype would both be useful.

3

Thanks Simon, we’re also struggling with not getting consistent topic_created events. Instead we get post_created with post_number = 1 and no topic_created. We checked both our logs and API/webhooks - nothing. That changed today, which now leaves me at a loss. More here:
https://meta.discourse.org/t/webhooks-for-the-first-post-in-a-series-topic-or-post/76365

4

Why does it matter? post_created with post number 1 is definitely a new topic. What else could it be?

5

It didn’t, and we shrugged it off until we saw what we originally expected in the log today: topic_created and no post_created header with post_number = 1. Now we’ve seen both and I’m trying to understand why and what the expected behavior is. It matters because we missed an event that is one of the purposes of the webhook: record and reward users who create a new topic.

6

I see, @tgxworld can you comment on this please?

8

Yea those are definitely useful. Another thing that I noticed is that we’re sending the suggested_topics in the webhook payload. It adds quite abit of size to the payload and I don’t think alot of people are using that.

9

@tgxworld Based on Simon’s reply, is the best way to differentiate a PM to make a request back to the API at “topics/get a single topic by id” and pass the ID for every post? Then if the archetype comes back private_message we’ll filter it out, if it comes back “regular” we’ll use it. We seem to get either a post created with post_number = 1 or a topic_created with no post_created. We’ll check for both and that should cover our use cases.

Is there any documentation on the JSON fields, possible values, and meaning for topics, posts, and users? For example, are there other possible values for archetype? What does actions_summary signify with id=n? Alternatively, if you could point us to somewhere in the code base that builds the JSON objects passed in the webhooks that would be something. We poked around but couldn’t find the data itself, just the events and objects passed.

10

Any chance these might be topics that were moved or had ownership reassigned? Staged users?

11

I don’t think so. We have a very active group of veterinarians posting, but it’s very vanilla stuff. Topics and replies. To my knowledge no one has reassigned or moved a topic. We don’t stage users.

12

トピックアーキタイプがポストのウェブフックに含まれていないという、似たような問題に直面しています。私たちは、誰かが公開投稿を行うか、または私たちにプライベートメッセージを送信した際に、サポートチケットシステムにチケットを作成するためにウェブフックを使用しています。問題は、公開投稿とプライベートメッセージを別々に処理しているため、ウェブフックハンドラ内でタイプを知る必要があることです。

API を使用して再度呼び出し、トピックの詳細を取得することは可能だと理解していますが、この情報がポストイベントのペイロードに含まれていれば、それほどの手間とオーバーヘッドは不要です。

これを追加するご意向はありますでしょうか？もし私たちがプルリクエストを送る場合、ご検討いただけますか？

13

プルリクエストはいつでも歓迎です :wink:

14

PR を提出しました。トピックのアーキタイプとカテゴリのスラッグを追加しました。