Notification Service


BaseUrl
https://notify.taskcluster.net/v1

The notification service, typically available at notify.taskcluster.net listens for tasks with associated notifications and handles requests to send emails and post pulse messages.

Functions

For more information on invoking the API methods described here, see Using the APIs in the manual.
SignatureSummary
email(payload) : voidSend an Email
pulse(payload) : voidPublish a Pulse Message
irc(payload) : voidPost IRC Message
ping() : voidPing Server

Send an Email

(experimental)

Method
post
Route
/email
Scopes
notify:email:<address>
Signature
email(payload) : void
Stability
experimental

Send an email to address. The content is markdown and will be rendered to HTML, but both the HTML and raw markdown text will be sent in the email. If a link is included, it will be rendered to a nice button in the HTML version of the email

Request Payload

Send Email Request (source)

Request to send an email

addressstring

E-mail address to which the message should be sent

subjectstring[1:255]

Subject line of the e-mail, this is plain-text

contentstring[1:102400]

Content of the e-mail as markdown, will be rendered to HTML before the email is sent. Notice that markdown allows for a few HTML tags, but won't allow inclusion of script tags and other unpleasantries.

linkObject of

Request to send an email

textstring[1:40]

Text to display on link.

hrefstring[1:1024]uri

Where the link should point to.

replyTostring

Reply-to e-mail (this property is optional)

templatestring
default: simple
  • simple
  • fullscreen

E-mail html template used to format your content.



Publish a Pulse Message

(experimental)

Method
post
Route
/pulse
Scopes
notify:pulse:<routingKey>
Signature
pulse(payload) : void
Stability
experimental

Publish a message on pulse with the given routingKey.

Request Payload

Post Pulse Message Request (source)

Request to post a message on pulse.

routingKeystring[0:255]

Routing-key to use when posting the message.

messageObject of

Request to post a message on pulse.

Anything ¯\_(ツ)_/¯


Post IRC Message

(experimental)

Method
post
Route
/irc
Scopes
notify:irc-channel:<channel>

notify:irc-user:<user>
Signature
irc(payload) : void
Stability
experimental

Post a message on IRC to a specific channel or user, or a specific user on a specific channel.

Success of this API method does not imply the message was successfully posted. This API method merely inserts the IRC message into a queue that will be processed by a background process. This allows us to re-send the message in face of connection issues.

However, if the user isn't online the message will be dropped without error. We maybe improve this behavior in the future. For now just keep in mind that IRC is a best-effort service.

Request Payload

Post IRC Message Request (source)

Request to post a message on IRC.

channelstring^[#&][^ ,\u0007]{1,199}$

Channel to post the message in. Please note that you must supply either user or channel, you cannot supply both.

userstring[1:255]^[A-Za-z\[\]\\~_\^{|}][A-Za-z0-9\-\[\]\\~_\^{|}]{0,254}$

User to post the message to. Please note that you must supply either user or channel, you cannot supply both.

messagestring[1:510]

IRC message to send as plain text.



Ping Server

Method
get
Route
/ping
Signature
ping() : void
Stability
stable

Respond without doing anything. This endpoint is used to check that the service is up.