Skip to content
Console
On this page

Templates

A Template is versioned content per channel.

A Template is versioned content per channel. Every spec change is a new version; a message renders from the version it pinned at admission.

Service Sylphx Notify · Resource type notify.sylphx.com/Template · Name pattern orgs/{org}/projects/{project}/envs/{env}/templates/{template} · Shape spec_status

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/templates/{template}.
uidstringtpl_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specTemplateSpecDesired state. Required.
statusTemplateStatusObserved state. Output only.

Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets a template.
GETlistLists templates.
POSTcreateCreates a template.
PATCHupdateUpdates a template.
DELETEdeleteDeletes a template.

get

Gets a template.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/templates/template · scope notify:read · effect read · Request, response and examples

list

Lists templates.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/templates · scope notify:read · effect read · paginated · Request, response and examples

create

Creates a template.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/templates · scope notify:write · effect write · Request, response and examples

update

Updates a template.

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/templates/template · scope notify:write · effect write · Request, response and examples

delete

Deletes a template.

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/templates/template · scope notify:write · effect destructive · Request, response and examples