Skip to content
SendTruss

Get the variables a workspace's template uses

GET
/workspaces/{workspace}/event-types/{name}/variables
curl --request GET \
  --url https://api.sendtruss.com/v1/workspaces/example/event-types/example/variables \
  --header 'Authorization: Bearer <token>'

The event, contact and system variables in the template this workspace sends for the event type, so you know which payload fields and contact attributes it reads. version and variables are null when the type has no template yet, and nothing is sent for it.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace
required
string
/^(?:[0-9A-Za-z]{26}|ref:[A-Za-z0-9._-]{1,128})$/

The workspace: our id, or ref: plus your reference for it, such as ref:cust_4821. A reference is letters, digits, ., _ and -, up to 128 characters, and needs no URL encoding.

name
required
string

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
data
required
object
version
required
integer | null
variables
required
object
event
required
Array<string>
contact
required
Array<string>
system
required
Array<string>
Examplegenerated
{
  "data": {
    "version": 1,
    "variables": {
      "event": [
        "example"
      ],
      "contact": [
        "example"
      ],
      "system": [
        "example"
      ]
    }
  }
}

Headers

Section titled “Headers”
Request-Id
required
string format: uuid

This request’s id. Quote it when you ask us about the request.

401

Section titled “401”

The API key is missing, malformed, revoked or expired.

Media typeapplication/json
object
message
required

What went wrong, for a person to read. It may change, so branch on code.

string
code
required

What went wrong, for your code to branch on. A new code is not a breaking change.

string
Allowed values: unauthenticated
doc_url
required

The entry on our errors page that explains this code.

string format: uri
request_id
required

This request’s id, the same as its Request-Id header. Quote it when you ask us about the request.

string format: uuid
Example
{
  "code": "unauthenticated"
}

Headers

Section titled “Headers”
Request-Id
required
string format: uuid

This request’s id. Quote it when you ask us about the request.

404

Section titled “404”

Nothing is at this path for your key. Another platform’s or another workspace’s resource answers the same as one that doesn’t exist.

Media typeapplication/json
object
message
required

What went wrong, for a person to read. It may change, so branch on code.

string
code
required

What went wrong, for your code to branch on. A new code is not a breaking change.

string
Allowed values: not_found
doc_url
required

The entry on our errors page that explains this code.

string format: uri
request_id
required

This request’s id, the same as its Request-Id header. Quote it when you ask us about the request.

string format: uuid
Example
{
  "code": "not_found"
}

Headers

Section titled “Headers”
Request-Id
required
string format: uuid

This request’s id. Quote it when you ask us about the request.

429

Section titled “429”

Too many requests. Wait for the seconds in Retry-After.

Media typeapplication/json
object
message
required

What went wrong, for a person to read. It may change, so branch on code.

string
code
required

What went wrong, for your code to branch on. A new code is not a breaking change.

string
Allowed values: rate_limited
doc_url
required

The entry on our errors page that explains this code.

string format: uri
request_id
required

This request’s id, the same as its Request-Id header. Quote it when you ask us about the request.

string format: uuid
Example
{
  "code": "rate_limited"
}

Headers

Section titled “Headers”
Request-Id
required
string format: uuid

This request’s id. Quote it when you ask us about the request.

Retry-After
integer

Seconds to wait before trying again.