Create a new subscription

post

https://rest-api.hellomoon.io/v0/subscriptions/create

NOTE: This endpoint is only callable by API keys in the following tiers:

Business

Developer

Enterprise

PremiumSharedRpc

StarterSharedRpc

UltimateSharedRpc

Create a new subscription to a stream

Body Params

body

name

string

required

The name given to the subscription for easier identification

targetType

string

enum

required

How the stream information is delivered. Kafka is only available for certain clients, please contact support to use Kafka.

Allowed:

targetValue

string | null

Only used when targetType === WEBHOOK. This is the endpoint the results will be delivered to via a POST request

filter

dataStream

string

enum

required

The stream that the subscription is receiving data from

authDetails

object | null

An optional set of auth details to send on push request

apiKey

string | null

The API key used to authenticate the Hello Moon service

idempotencyKey

string

length between 1 and 256

An optional idempotency key to ensure that only one subscription may exist at a time. It must be between 1 and 256 characters long and can only contain alphanumeric characters, hyphens, underscores, and periods.

Response

Language

Credentials

Bearer

JWT

Request

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success