Skip to content
Changelog

Report a bug

Ntfy integration: operations for AI agents

Ntfy connects to Type.com as an integration. This page lists the 54 operations documented for Claude and Codex in Type.com: 12 read, 5 write, 37 destructive.

About Ntfy

Send push notifications to your phone or desktop via PUT/POST

Categories: Email & Messaging

How to connect Ntfy to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

54 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

54 operations listed.

Publishing payloads and notification lifecycle

  • Write

    Mark notification read and dismiss (clear)

    Emits message_clear, marking read and dismissing a supporting client notification; does not delete stored server history.

    PUT /{topic}/{sequence_id}/clear

  • Write

    Mark notification read and dismiss (read)

    Emits message_clear, marking read and dismissing a supporting client notification; does not delete stored server history.

    PUT /{topic}/{sequence_id}/read

  • Write

    Mark notification read and dismiss (clear)

    Emits message_clear to supporting clients, marking read and dismissing the notification drawer entry; does not delete stored server history. GET is a mutating alias, not a retrieval.

    GET /{topic}/{sequence_id}/clear

  • Write

    Mark notification read and dismiss (read)

    Emits message_clear to supporting clients, marking read and dismissing the notification drawer entry; does not delete stored server history. GET is a mutating alias, not a retrieval.

    GET /{topic}/{sequence_id}/read

  • Write

    Forward Matrix push notification

    Matrix Push Gateway bridge is only supported with UnifiedPush and ntfy, not a generic Matrix gateway. Requires exact notification/pushkey payload and working Android/Matrix client integration; no recipient grant inferred.

    POST /_matrix/push/v1/notify

  • Destructive

    Publish a JSON notification

    Root JSON publisher requires topic; do not send JSON to /{topic} expecting root-JSON parsing. Optional sequence_id can replace/delete an existing scheduled message; ordinary new messages notify subscribers. Type JSON body transport matches this documented encoding. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /

  • Destructive

    Publish text or binary notification

    Topic publisher accepts a raw text/binary body, with optional headers/query parameters; Type raw only serializes JSON/form and cannot send arbitrary text/binary bodies. Sequence-ID can replace an existing pending scheduled message. Prefer the separate root JSON publisher for supported JSON transport. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /{topic}

  • Destructive

    Publish or update sequence notification

    A sequence update replaces the client notification. Delivered server/cache history is append-only; pending scheduled messages with the same sequence ID are deleted/replaced. Client support determines notification behavior; raw text request transport is not available through Type JSON/form. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /{topic}/{sequence_id}

  • Destructive

    Publish a JSON notification

    Root JSON publisher requires topic; do not send JSON to /{topic} expecting root-JSON parsing. Optional sequence_id can replace/delete an existing scheduled message; ordinary new messages notify subscribers. Type JSON body transport matches this documented encoding. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    PUT /

  • Destructive

    Publish text or binary notification

    Topic publisher accepts a raw text/binary body, with optional headers/query parameters; Type raw only serializes JSON/form and cannot send arbitrary text/binary bodies. Sequence-ID can replace an existing pending scheduled message. Prefer the separate root JSON publisher for supported JSON transport. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    PUT /{topic}

  • Destructive

    Publish or update sequence notification

    A sequence update replaces the client notification. Delivered server/cache history is append-only; pending scheduled messages with the same sequence ID are deleted/replaced. Client support determines notification behavior; raw text request transport is not available through Type JSON/form. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    PUT /{topic}/{sequence_id}

  • Destructive

    Set notification title

    Named root-JSON title payload; topic/message delivery still applies; Unicode header encoding alternatives are preserved. This is a named payload capability sharing the root JSON publishing route; it is not another HTTP endpoint. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /

  • Destructive

    Set notification priority

    Named priority payload accepts documented numeric/named levels. High-priority notification behavior depends on client/device settings. This is a named payload capability sharing the root JSON publishing route; it is not another HTTP endpoint. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /

  • Destructive

    Set tags and emoji labels

    Named tags payload decorates the notification; documented emoji substitutions and platform differences remain in the contract. This is a named payload capability sharing the root JSON publishing route; it is not another HTTP endpoint. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /

  • Destructive

    Publish Markdown notification

    Named Markdown payload; rendering support varies by client. This does not execute arbitrary HTML. This is a named payload capability sharing the root JSON publishing route; it is not another HTTP endpoint. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /

  • Destructive

    Set click target

    Named click URL payload opens a target when a user clicks the notification; publishing does not itself fetch or execute that target. This is a named payload capability sharing the root JSON publishing route; it is not another HTTP endpoint. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /

  • Destructive

    Set notification icon

    Named icon URL payload; URL/image accessibility and supported-client rendering requirements apply. Supplying an icon is not a binary upload. This is a named payload capability sharing the root JSON publishing route; it is not another HTTP endpoint. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /

  • Destructive

    Attach a remote file URL

    Named attach URL/filename payload; sends a reference to subscribers, not proof Type downloaded or uploaded the file. Attachment limits and client behavior apply. This is a named payload capability sharing the root JSON publishing route; it is not another HTTP endpoint. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /

  • Destructive

    Publish notification action buttons

    Named actions payload; view/broadcast/http/copy actions run in supporting clients when triggered. Publishing the payload does not itself perform those downstream actions. This is a named payload capability sharing the root JSON publishing route; it is not another HTTP endpoint. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /

  • Destructive

    Add open-URL action button

    Named action=view payload on shared root JSON route; opens a URL in the client when clicked, with optional clear behavior. This is a named payload capability sharing the root JSON publishing route; it is not another HTTP endpoint. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /

  • Destructive

    Add Android broadcast action button

    Named action=broadcast payload requires supporting Android client/app integration and intent/extras; Type does not obtain Android broadcast permissions. This is a named payload capability sharing the root JSON publishing route; it is not another HTTP endpoint. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /

  • Destructive

    Add HTTP request action button

    Named action=http payload can trigger a configured HTTP request when a user acts in a supporting client. Its remote side effects are payload-dependent; it is not a direct Type provider API call. This is a named payload capability sharing the root JSON publishing route; it is not another HTTP endpoint. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /

  • Destructive

    Add copy-to-clipboard action button

    Named action=copy payload modifies a supporting client clipboard when clicked; no clipboard/device permission is inferred. This is a named payload capability sharing the root JSON publishing route; it is not another HTTP endpoint. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /

  • Destructive

    Schedule notification delivery

    Named delay payload queues future delivery; replacing the same sequence ID deletes the previous pending message. No Type background worker or long-lived wait is established by one HTTP request. This is a named payload capability sharing the root JSON publishing route; it is not another HTTP endpoint. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /

  • Destructive

    Replace a scheduled notification

    Same sequence ID deletes the pending scheduled message and replaces it with the new message, unlike append-only delivered-message history. This is a named payload capability sharing the root JSON publishing route; it is not another HTTP endpoint. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /

  • Destructive

    Publish using message templates

    Named template payload renders request data server-side; template configuration/syntax and trusted input requirements apply. Named template availability depends on the target server. This is a named topic-publisher header/query payload capability, not a root-JSON field or another endpoint. Raw text/binary bodies are outside Type serialization; documented JSON template input can use JSON where the template contract calls for it. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /{topic}

  • Destructive

    Publish with predefined template

    Named template selection uses templates available on the target server; existence of a sample name does not establish account/server configuration. This is a named topic-publisher header/query payload capability, not a root-JSON field or another endpoint. Raw text/binary bodies are outside Type serialization; documented JSON template input can use JSON where the template contract calls for it. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /{topic}

  • Destructive

    Publish with a custom template

    Custom template use depends on target-server configuration and authorized template definition; no server filesystem/configuration access is provided by Type. This is a named topic-publisher header/query payload capability, not a root-JSON field or another endpoint. Raw text/binary bodies are outside Type serialization; documented JSON template input can use JSON where the template contract calls for it. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /{topic}

  • Destructive

    Publish with inline template

    Inline template rendering uses documented template/query/header syntax; this is payload rendering, not a separate template-management API. This is a named topic-publisher header/query payload capability, not a root-JSON field or another endpoint. Raw text/binary bodies are outside Type serialization; documented JSON template input can use JSON where the template contract calls for it. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /{topic}

  • Destructive

    Send notification by email

    Named email payload additionally sends email; enabled mail backend, recipient limits and authentication/plan conditions apply. No recipient ownership/grant was inspected. This is a named payload capability sharing the root JSON publishing route; it is not another HTTP endpoint. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /

  • Destructive

    Trigger a phone-call notification

    Named call payload triggers a phone call, subject to configured provider, eligible tier, verified number and quotas. This is an external notification, not read-only lookup. This is a named payload capability sharing the root JSON publishing route; it is not another HTTP endpoint. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /

  • Destructive

    Control message caching

    Named cache flag controls storage of the newly published message; disabling cache is not evidence of deletion of pre-existing cached messages. This is a named topic-publisher header/query payload capability, not a root-JSON field or another endpoint. Raw text/binary bodies are outside Type serialization; documented JSON template input can use JSON where the template contract calls for it. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /{topic}

  • Destructive

    Control Firebase forwarding

    Named Firebase flag disables forwarding through FCM for this publication; mobile delivery and device subscription behavior remain separate. This is a named topic-publisher header/query payload capability, not a root-JSON field or another endpoint. Raw text/binary bodies are outside Type serialization; documented JSON template input can use JSON where the template contract calls for it. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /{topic}

  • Destructive

    Publish UnifiedPush payload

    Named UnifiedPush flag disables Firebase and can base64-encode binary messages; client/distributor integration is required. Binary request bodies are outside Type raw JSON/form. This is a named topic-publisher header/query payload capability, not a root-JSON field or another endpoint. Raw text/binary bodies are outside Type serialization; documented JSON template input can use JSON where the template contract calls for it. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    POST /{topic}

  • Destructive

    Publish notification via GET (publish)

    GET publishes a notification and optional sequence_id/delay can replace pending scheduled state. This is mutating despite GET; Type’s method-only read access does not make it read-only. Header aliases become URL-encoded query fields.

    GET /{topic}/publish

  • Destructive

    Publish notification via GET (send)

    GET publishes a notification and optional sequence_id/delay can replace pending scheduled state. This is mutating despite GET; Type’s method-only read access does not make it read-only. Header aliases become URL-encoded query fields.

    GET /{topic}/send

  • Destructive

    Publish notification via GET (trigger)

    GET publishes a notification and optional sequence_id/delay can replace pending scheduled state. This is mutating despite GET; Type’s method-only read access does not make it read-only. Header aliases become URL-encoded query fields.

    GET /{topic}/trigger

  • Destructive

    Delete client notification sequence

    Emits message_delete to remove the notification from supporting clients; delivered server/cache history remains append-only, and new publications can revive a sequence.

    DELETE /{topic}/{sequence_id}

  • Destructive

    Cancel pending scheduled notification

    Deletes the pending scheduled message before delivery and emits message_delete; this named lifecycle capability shares the sequence deletion route.

    DELETE /{topic}/{sequence_id}

  • Destructive

    Delete client notification sequence

    Emits message_delete, removing the notification from supporting client drawers/databases. Delivered server history remains append-only; a new publication can revive a deleted sequence. GET is a mutating alias.

    GET /{topic}/{sequence_id}/delete

  • Destructive

    Cancel pending scheduled notification

    Deletes the pending scheduled message from the server so it will never be delivered and emits message_delete; this named lifecycle capability shares the sequence deletion route. GET is destructive despite method-only raw read access.

    GET /{topic}/{sequence_id}/delete

  • Destructive

    Upload attachment and notify

    Named raw binary upload capability shares topic publishing route. Type raw JSON/form does not stream binary files; attachment quota/storage/expiry and response attachment metadata remain in source contract. Maximum combined payload effect: optional sequence_id or Sequence-ID/header/query targeting can delete/replace an existing pending scheduled message. The named facet does not restrict other supported publisher options; an ordinary new publication without that combination is a notification write.

    PUT /{topic}

Subscription transports

  • Read

    Subscribe to json stream

    Long-lived HTTP subscription returns json events; Type’s 30-second raw request deadline is not a persistent subscriber. Prefer an explicit finite poll where supported.

    GET /{topic}/json

  • Read

    Poll json cached messages

    Named finite query variant requires poll=1 and optional since; default poll reads the entire cache, which can be large. Response is json format, not automatically a JSON array. Shares the subscription route. Finite retrieval is not proof of complete history: server replay caps can omit earlier messages, and Type does not expose ntfy X-Messages-Truncated; inline responses additionally cap at 200,000 characters and can be truncated.

    GET /{topic}/json

  • Read

    Subscribe to sse stream

    Long-lived HTTP subscription returns sse events; Type’s 30-second raw request deadline is not a persistent subscriber. Prefer an explicit finite poll where supported.

    GET /{topic}/sse

  • Read

    Poll sse cached messages

    Named finite query variant requires poll=1 and optional since; default poll reads the entire cache, which can be large. Response is sse format, not automatically a JSON array. Shares the subscription route. Finite retrieval is not proof of complete history: server replay caps can omit earlier messages, and Type does not expose ntfy X-Messages-Truncated; inline responses additionally cap at 200,000 characters and can be truncated.

    GET /{topic}/sse

  • Read

    Subscribe to raw stream

    Long-lived HTTP subscription returns raw events; Type’s 30-second raw request deadline is not a persistent subscriber. Prefer an explicit finite poll where supported.

    GET /{topic}/raw

  • Read

    Poll raw cached messages

    Named finite query variant requires poll=1 and optional since; default poll reads the entire cache, which can be large. Response is raw format, not automatically a JSON array. Shares the subscription route. Finite retrieval is not proof of complete history: server replay caps can omit earlier messages, and Type does not expose ntfy X-Messages-Truncated; inline responses additionally cap at 200,000 characters and can be truncated.

    GET /{topic}/raw

  • Read

    Replay cached notifications

    since selects replay starting at message ID, timestamp or duration; cache retention and replay size limits apply. Named query/path variant sharing subscription transport; use poll=1 for bounded retrieval rather than waiting beyond Type deadline. Finite retrieval is not proof of complete history: server replay caps can omit earlier messages, and Type does not expose ntfy X-Messages-Truncated; inline responses additionally cap at 200,000 characters and can be truncated.

    GET /{topic}/json

  • Read

    Fetch latest notification

    Use poll=1&since=latest for finite latest-cache lookup; not a persistent subscription. Named query/path variant sharing subscription transport; use poll=1 for bounded retrieval rather than waiting beyond Type deadline. Finite retrieval is not proof of complete history: server replay caps can omit earlier messages, and Type does not expose ntfy X-Messages-Truncated; inline responses additionally cap at 200,000 characters and can be truncated.

    GET /{topic}/json

  • Read

    Include scheduled notifications

    Use poll=1&scheduled=1 (sched=1 alias) to include future pending messages; reading does not cancel them. Named query/path variant sharing subscription transport; use poll=1 for bounded retrieval rather than waiting beyond Type deadline. Finite retrieval is not proof of complete history: server replay caps can omit earlier messages, and Type does not expose ntfy X-Messages-Truncated; inline responses additionally cap at 200,000 characters and can be truncated.

    GET /{topic}/json

  • Read

    Filter subscribed notifications

    Use exact documented ID/since/title/message/priority/tags filters; headers/query encodings and conjunctive semantics follow source. Named query/path variant sharing subscription transport; use poll=1 for bounded retrieval rather than waiting beyond Type deadline. Finite retrieval is not proof of complete history: server replay caps can omit earlier messages, and Type does not expose ntfy X-Messages-Truncated; inline responses additionally cap at 200,000 characters and can be truncated.

    GET /{topic}/json

  • Read

    Read multiple topics

    Topic path accepts comma-separated topic names; each topic still requires read permission. No wildcard or all-account grant is inferred. Named query/path variant sharing subscription transport; use poll=1 for bounded retrieval rather than waiting beyond Type deadline. Finite retrieval is not proof of complete history: server replay caps can omit earlier messages, and Type does not expose ntfy X-Messages-Truncated; inline responses additionally cap at 200,000 characters and can be truncated.

    GET /{topic}/json

  • Read

    Subscribe through WebSocket

    This is an HTTP Upgrade/WebSocket protocol endpoint, not a completed Type raw GET subscription. Persistent WebSocket transport is not implemented by Type raw API requests.

    GET /{topic}/ws

See How connections work for access and permissions, or browse all integrations.