Subscriptions
Objects

Add subscriptions

Changed on

Add subscriptions for an object. If a subscription already exists, it will be updated. This endpoint also handles inline identifications for the recipient.

post/v1/objects/{collection}/{object_id}/subscriptions

Request

  • Base URL: https://api.knock.app
  • URL: https://api.knock.app/v1/objects/{collection}/{object_id}/subscriptions
  • Auth: HTTP bearer

Path parameters

object_idstring required

Unique identifier for the object.

collectionstring required

The collection this object belongs to.

Request body

propertiesobject nullable

The custom properties associated with the subscription relationship.

Example request

{
  "properties": {
    "key": "value"
  },
  "recipients": [
    "user_1",
    "user_2"
  ]
}

Response

OK

__typenamestring required

The typename of the schema.

inserted_atstring date-time required

Timestamp when the resource was created.

propertiesobject nullable

The custom properties associated with the subscription relationship.

updated_atstring date-time required

The timestamp when the resource was last updated.

Example response

[
  {
    "__typename": "Subscription",
    "inserted_at": "2021-01-01T00:00:00Z",
    "object": {
      "__typename": "Object",
      "collection": "assets",
      "created_at": null,
      "id": "specimen_25",
      "properties": {
        "classification": "Theropod",
        "config": {
          "biz": "baz",
          "foo": "bar"
        },
        "name": "Velociraptor",
        "status": "contained"
      },
      "updated_at": "2024-05-22T12:00:00Z"
    },
    "recipient": {
      "__typename": "User",
      "avatar": null,
      "created_at": null,
      "email": "jane@ingen.net",
      "id": "jane",
      "name": "Jane Doe",
      "phone_number": null,
      "timezone": null,
      "updated_at": "2024-05-22T12:00:00Z"
    },
    "updated_at": "2021-01-01T00:00:00Z"
  }
]

Changes

  • 6f88a4142e34Revision changes
    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

  • fcba175ebc76Revision changes
    • breaking

      the request property ////// became not nullable

    • breaking

      the request property ////// became not nullable

    • breaking

      the ////// request property type changed from boolean to no type

    • breaking

      the ////// request property type changed from boolean to no type

    • info

      added subschema #1 subschema #3 to the ////// request property anyOf list

    • info

      added subschema #1 subschema #3 to the ////// request property anyOf list