Docs are wrong about the return type of POST:

Didn’t know where to put this, so I’m guessing this is a good enough place.

Just wanted to bring up that the documentation for creating alerts channels is a bit wrong.
The docs state that the return json for that is

  "channel": {
    "id": "integer",
    "name": "string",
    "type": "string",
    "configuration": "hash",
    "links": {
      "policy_ids": [

but I’m actually getting this structure (note the channels list)

{'channels': [{
                'configuration': "hash,
                'id': 'int',
                'links': {'policy_ids': []},
                'name': 'string',
                'type': 'string'}],
 'links': {'channel.policy_ids': '/v2/policies/{policy_id}'}}

Hey @dumitru.melenteanu - Thanks for reporting that! I’ll get it sent over to the documentation team.

Hey @dumitru.melenteanu

Just checking in to see if you are looking at this:

or this:

I can’t see a JSON Response in the docs, but I can in the API explorer. I want to make sure I report this to the right team :slight_smile:

Hi, @RyanVeitch,

Both of those links have the same JSON.

The docs page has the JSON Response under Create new notification channels. Couldn’t find a way to get a direct link.

Hi @dumitru.melenteanu

I don’t see that in the docs (sorry if I’m just missing it)… What I can see in docs is the curl command to send to create new channels, not the JSON response from that API call.

Oh… I misread the POST payload as the response. Sorry about that. :man_facepalming:

They do look awfully similar.

1 Like

No worries @dumitru.melenteanu

I have submitted a request for the API Explorer to have that updated to match the real response.

1 Like