📚 Docs Feedback: Faulty "to" description for event triggering

[JonasDoe]

Duplicates

• I have searched the existing issues

Related page

https://docs.novu.co/api-reference/events/trigger-event

Kind of issue

Unclear explanations

Issue description

I think the documentation about the "to" has two issues:

• It doesn't really tell that lists are allowed since to types are "just" object or string, but not object[] and string
• It is faulty about how to specify subscribers with type 3, where it claims to require a "topicKey"
  
  Instead it must be "subscriberId"
  For example, in my case the correct usage would be:

{
...
  "to": [
    {
      "type": "Topic",
      "topicKey": "my_topic"
    },
    {
      "type": "Subscriber",
      "subscriberId": "my_id"
    }
  ]
...
}

But by folllowing the documentation, I'ld neither know that I can apply a list here, nor that I must pass "subscriberId": "my_id" instead of "topicKey": "my_id".

Context 🔦

No response

[linear]

NV-3832 📚 Docs Feedback: Faulty "to" description for event triggering