Sign in
Signal

Gets a signal by its id.

get/signal/{signalId}

Path parameters

signalIdstring required

The id of the signal to retrieve.

Response

OK

idstring required

The unique identifier of the signal.

namestring required

The human-readable name of the signal.

descriptionstring nullable

Optional description.

audienceIdstring required

The id of the audience the signal targets.

jobDefinitionIdstring required

The id of the job definition each firing creates a job from.

revisionNumberinteger nullable

Pinned revision number; null means "latest at fire time".

intervalSecondsinteger required

Seconds between consecutive firings.

nextRunAtstring date-time required

Timestamp of the next scheduled run.

lastRunAtstring date-time nullable

Timestamp of the most recent run (null if the signal has never fired).

isPausedboolean required

Whether the scheduler is currently skipping this signal.

isPublicboolean required

Whether the signal is readable by every authenticated user.

ownerIdstring uuid required

The customer id of the signal owner.

ownerMailstring required

The email of the signal owner.

organizationIdstring required

The id of the organization that owns the entity.

createdAtstring date-time required

When the signal was created.

Changes

No recorded changes to this endpoint across all 6 revisions of this API.