Socketless API (1.0.0)

Download OpenAPI specification:Download

Webhook Webhook

header Parameters

x-socketless-signature

required

string

Signature of payload in HMAC-SHA256

Request Body schema: application/json

Any of

action required	string Value: "CONNECTION_OPEN"
required	object

Responses

Request samples

Payload

Content type

application/json

{"action": "CONNECTION_CLOSE",
"data": {"connection": {"clientId": "string",
"identifier": "string"
}
}
}

Response samples

200

Content type

application/json

{"messages": [{"message": null,
"clients": ["string"
],
"feeds": ["string"
]
}
],
"feeds": [{"feeds": ["string"
],
"action": "join",
"clients": ["string"
]
}
]
}

Retrieve the connection token for the client

Authorizations:

Bearer

Request Body schema: application/json

identifier required	string
	object
feeds	Array of strings[^[a-z0-9_.]+$]
overrideFeeds	boolean Default: true

Responses

Request samples

Payload

Content type

application/json

{"identifier": "string",
"webhook": {"url": "http://example.com",
"secret": "string",
"options": { }
},
"feeds": ["string"
],
"overrideFeeds": true
}

Response samples

200

Content type

application/json

{"token": "string",
"identifier": "string",
"url": "string"
}

Manage feeds

Authorizations:

Bearer

Request Body schema: application/json

required

Array of objects or object

Any of

Array

required	Array of strings or string
action required	string Enum: "join" "leave" "set"
required	Array of strings or string

Responses

Request samples

Payload

Content type

application/json

{"actions": [{"feeds": ["string"
],
"action": "join",
"clients": ["string"
]
}
]
}

Send messages to clients and feeds

Authorizations:

Bearer

Request Body schema: application/json

required

Array of objects or object

Any of

Array

message	any
	Array of strings or string
	Array of strings or string

Responses

Request samples

Payload

Content type

application/json

{"messages": [{"message": null,
"clients": ["string"
],
"feeds": ["string"
]
}
]
}