Posts a message from someone on another service into a linked channel. The community writes the message, attributed to that person.
Input
application/jsonattachments
array
Optional
Files attached to the message.
maxLength: 10 itemsauthor
refsocial.colibri.beta.bridge.defs#remoteAuthor
Required
Who sent the message.
channel
stringspace-ref
Required
The linked channel or thread the record lives in.
community
stringdid
Required
The community the registration belongs to.
createdAt
stringdatetime
Optional
When the message was sent on the other service. Defaults to now.
facets
array
Optional
Annotations over ranges of the text.
forward
refsocial.colibri.beta.message#forward
Optional
Content forwarded from another Colibri message.
parent
refsocial.colibri.beta.defs#recordRef
Optional
The message this one replies to.
registration
stringtid
Required
Record key of the registration.
remoteMessage
string
Optional
The message's id on the other service.
maxLength: 256 bytestext
string
Required
The message body.
maxLength: 2048 bytesOutput
application/jsonrkey
stringrecord-key
Required
Record key of the record the community wrote.
Errors
AuthRequired
The request is missing, malformed, or unverifiable service auth. CommunityNotFound
No community exists at the given DID. RegistrationNotFound
The community has no bridge registration with that id. Forbidden
The caller is not the bridge this registration belongs to. RegistrationDisabled
An admin has paused this registration. ChannelNotLinked
The channel is not linked to this registration. RateLimited
The bridge sent too many requests. Retry after the interval in the response headers. CredentialsUnavailable
The AppView cannot act as the community because its stored credentials are missing or unusable. Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"description": "Posts a message from someone on another service into a linked channel. The community writes the message, attributed to that person.",
"errors": [
{
"description": "The request is missing, malformed, or unverifiable service auth.",
"name": "AuthRequired"
},
{
"description": "No community exists at the given DID.",
"name": "CommunityNotFound"
},
{
"description": "The community has no bridge registration with that id.",
"name": "RegistrationNotFound"
},
{
"description": "The caller is not the bridge this registration belongs to.",
"name": "Forbidden"
},
{
"description": "An admin has paused this registration.",
"name": "RegistrationDisabled"
},
{
"description": "The channel is not linked to this registration.",
"name": "ChannelNotLinked"
},
{
"description": "The bridge sent too many requests. Retry after the interval in the response headers.",
"name": "RateLimited"
},
{
"description": "The AppView cannot act as the community because its stored credentials are missing or unusable.",
"name": "CredentialsUnavailable"
}
],
"input": {
"encoding": "application/json",
"schema": {
"properties": {
"attachments": {
"description": "Files attached to the message.",
"items": {
"description": "A file uploaded earlier with uploadBlob.",
"ref": "social.colibri.beta.message#attachment",
"type": "ref"
},
"maxLength": 10,
"type": "array"
},
"author": {
"description": "Who sent the message.",
"ref": "social.colibri.beta.bridge.defs#remoteAuthor",
"type": "ref"
},
"channel": {
"description": "The linked channel or thread the record lives in.",
"format": "space-ref",
"type": "string"
},
"community": {
"description": "The community the registration belongs to.",
"format": "did",
"type": "string"
},
"createdAt": {
"description": "When the message was sent on the other service. Defaults to now.",
"format": "datetime",
"type": "string"
},
"facets": {
"description": "Annotations over ranges of the text.",
"items": {
"description": "An annotation.",
"ref": "social.colibri.beta.richtext.facet",
"type": "ref"
},
"type": "array"
},
"forward": {
"description": "Content forwarded from another Colibri message.",
"ref": "social.colibri.beta.message#forward",
"type": "ref"
},
"parent": {
"description": "The message this one replies to.",
"ref": "social.colibri.beta.defs#recordRef",
"type": "ref"
},
"registration": {
"description": "Record key of the registration.",
"format": "tid",
"type": "string"
},
"remoteMessage": {
"description": "The message's id on the other service.",
"maxLength": 256,
"type": "string"
},
"text": {
"description": "The message body.",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"community",
"registration",
"channel",
"author",
"text"
],
"type": "object"
}
},
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"rkey": {
"description": "Record key of the record the community wrote.",
"format": "record-key",
"type": "string"
}
},
"required": [
"rkey"
],
"type": "object"
}
},
"type": "procedure"
}