Notification Services

Create notification service for user

Creates a new notification service for a user. Users can only create services for themselves.

post/users/{userId}/notification-services

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/users/{userId}/notification-services
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Path parameters

userIdstring required
Example:1357158568008091264

ID of the user to create notification service for (must be the current user)

Request body

urlstring required

URL endpoint for notifications

format'text' | 'markdown' | 'html' required

Format for notification messages

Example request

{
  "url": "https://service.example.com/planka",
  "format": "text"
}

Response

Notification service created successfully

Example response

{
  "item": {
    "id": "1357158568008091264",
    "userId": "1357158568008091265",
    "boardId": "1357158568008091266",
    "url": "https://service.example.com/planka",
    "format": "text",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.