API docs by Redocly

envoy API (0.2.79)

Download OpenAPI specification:

API Documentation for envoy

Emails

Create Emails

Authorizations:
bearerAuthapiKeyAuth
header Parameters
bedrock-response-envelope
string
Enum: "true" "false"
Request Body schema: application/json
optional
Array of objects or null
Array of objects or null
Array of objects
object
object or null
subject
string
Array of objects

Responses

Request samples

Content type
application/json
{
  • "bcc": [
    ],
  • "cc": [
    ],
  • "content": [
    ],
  • "from": {
    },
  • "replyTo": {
    },
  • "subject": "Test Email",
  • "to": [
    ]
}

Response samples

Content type
application/json
{
  • "_errors": [
    ],
  • "_metadata": {
    },
  • "_warnings": [
    ],
  • "data": {
    }
}

Messages

Create Messages

Authorizations:
bearerAuthapiKeyAuth
query Parameters
debug
boolean
Example: debug=true
header Parameters
bedrock-response-envelope
string
Enum: "true" "false"
Request Body schema: application/json
optional
channel
string
from
string
messageBody
string or null
object or null
to
string

Responses

Request samples

Content type
application/json
{
  • "channel": "sms",
  • "from": 447894563210,
  • "messageBody": "This is a test message.",
  • "options": {
    },
  • "to": 447894563210
}

Response samples

Content type
application/json
{
  • "_errors": [
    ],
  • "_metadata": {
    },
  • "_warnings": [
    ],
  • "data": {
    }
}

Responses

Get Responses

Authorizations:
bearerAuthapiKeyAuth
query Parameters
debug
boolean
Example: debug=true
from_number
string
Example: from_number=from_number
channel
string
Example: channel=channel
msg_date
string
Example: msg_date=msg_date
to_number
string
Example: to_number=to_number
header Parameters
bedrock-response-envelope
string
Enum: "true" "false"

Responses

Response samples

Content type
application/json
{
  • "_errors": [
    ],
  • "_metadata": {
    },
  • "_warnings": [
    ],
  • "data": {
    }
}

Create Responses

Authorizations:
bearerAuthapiKeyAuth
query Parameters
debug
boolean
Example: debug=true
header Parameters
bedrock-response-envelope
string
Enum: "true" "false"
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "_errors": [
    ],
  • "_metadata": {
    },
  • "_warnings": [
    ],
  • "data": {
    }
}

SlackMessageReceivers

Create SlackMessageReceivers

header Parameters
bedrock-response-envelope
string
Enum: "true" "false"
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "_errors": [
    ],
  • "_metadata": {
    },
  • "_warnings": [
    ],
  • "data": {
    }
}

SlackMessages

Get SlackMessages

Authorizations:
bearerAuthapiKeyAuth
query Parameters
conversation
string
Example: conversation=conversation
since_date
string
Example: since_date=since_date
limit
integer
Example: limit=123456
header Parameters
bedrock-response-envelope
string
Enum: "true" "false"

Responses

Response samples

Content type
application/json
{
  • "_errors": [
    ],
  • "_metadata": {
    },
  • "_warnings": [
    ],
  • "data": {
    }
}

Create SlackMessages

Authorizations:
bearerAuthapiKeyAuth
header Parameters
bedrock-response-envelope
string
Enum: "true" "false"
Request Body schema: application/json
optional
blocks
Array of objects or null
messageBody
string or null
to
string

Responses

Request samples

Content type
application/json
{
  • "blocks": [
    ],
  • "messageBody": "This is a test message.",
  • "to": "tco"
}

Response samples

Content type
application/json
{
  • "_errors": [
    ],
  • "_metadata": {
    },
  • "_warnings": [
    ],
  • "data": {
    }
}

Status

Get Status

query Parameters
debug
boolean
Example: debug=true
header Parameters
bedrock-response-envelope
string
Enum: "true" "false"

Responses

Response samples

Content type
application/json
{
  • "_errors": [
    ],
  • "_metadata": {
    },
  • "_warnings": [
    ],
  • "data": {
    }
}