Contents x
    v1 Publish message to the server
    • 26 Mar 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    v1 Publish message to the server

    • Updated on 26 Mar 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Article Summary

    Post
    /v1/tenants/{tenantId}/projects/{projectId}/topics/{topicId}:publish

    Publish single or multiple messages to the server via a topic

    Security
    API Key
    Header parameter nameAuthorization

    AWS Cognito Authorizer. Since there are no custom scopes the ID Token must be used for authorization

    Path parameters
    tenantId
    stringRequired

    The RapidIdentity Cloud tenant id

    projectId
    stringRequired

    The project id this service belongs. MUST be builtin or custom

    topicId
    stringRequired

    The routing key name. Must not contain builtin_ or custom_ as these are reserved words

    Body parameters

    The messages in the request to publish

    Expand All
    object
    messages
    Array of object (PubsubMessageV1) Required
    object
    data
    string Required
    messageId
    string Required
    publishTime
    string Required
    Responses
    200

    200 response

    object
    messageIds
    Array of string

    The server assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic

    string
    400

    Body is not present or formatted incorrectly

    object
    error
    string
    403

    The request is not authorized. Check that an api key exists and that the api key is valid for the tenantId

    object
    error
    string
    500

    Unable to retrieve queue as name does not exist

    object
    error
    string
    501

    The request does not have a projectId of custom or builtin

    object
    error
    string
    503

    Unable to connect to pubsub service

    object
    error
    string
    Was this article helpful?
    What's Next