Skip to content

Webhook query parameter incorrectly documented #89

@pixxies

Description

@pixxies

Issue: https://github.com/top-gg/docs/blob/master/docs/Resources/webhooks.mdx#bot-webhooks

Problem:
The documentation says the query parameter is sent as a string. This is incorrect. It's sent as an object with parameters as properties and their values as the property values.

Actual payload example from the webhook:

{
   user: '491002268401926145',
   type: 'upvote',
   query: { source: 'command' },
   isWeekend: true,
   bot: '675996677366218774'
 }

Solution:
The query parameter description needs to be fixed to reflect the fact the webhook sends this property as an object with the parameters as properties inside that object, and not a string.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions