GEgetstream
product:chat

Check Pub/Sub

Changed on

Validates that Stream can publish to a customer-owned GCP Pub/Sub topic

post/check_gcp_pubsub

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/check_gcp_pubsub
  • Auth
    • API key in header Authorization and API key in query parameter api_key and API key in header Stream-Auth-Type
    • or API key in query parameter api_key and API key in header Stream-Auth-Type

Request body

gcp_pubsub_event_based_ordering_key_enabledboolean

Publish the test message with an ordering key through the regional endpoint, as a hook with ordering enabled would; requires gcp_pubsub_region

gcp_pubsub_regionstring

GCP region used for the regional Pub/Sub endpoint when ordering is enabled

gcp_pubsub_topicstring

Fully qualified GCP Pub/Sub topic name (projects/{project}/topics/{topic})

Response

Successful response

dataobject

Error data

durationstring required
errorstring

Error text

statusstring required

Validation result. One of: ok, error

Changes