Skip to navigation

Nudge

Nudge the assigned reviewer over email and Slack, as the step’s bell does in the app. One nudge per step goes out an hour however many times it is called, and none on a draft, whose reviewers hear nothing until it is published: sent says whether this one went out and, when not, reason says why (throttled, with retryInMinutes, or draft). lastNudgedAt on the step says when the last one went. A step with no reviewer is 409 no_reviewer, and a key whose maker has left the workspace is 403 forbidden: a nudge comes from a person.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

stepIdstringRequired

Response

This endpoint returns an object.
stepIdstring
sentboolean
Whether the reviewer is reminded now, by email and Slack.
reviewerobject
The step's reviewer, who was reminded or would have been.
queuedbooleanDeprecated

Always true, from before the answer said more. Read sent.

reasonenumOptional

Why not, when sent is false; null when it is true.

Allowed values:
retryInMinutesintegerOptional

When throttled, how many minutes until the reviewer can be nudged again; null otherwise.

Errors

403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error