Skip to main content

Nudge API

This API allows clients to read and create custom nudges to users. Depending on the configuration this typically results in a notification being sent to an employee via email, Teams or Slack.

Throughout the API an 'api_id' is used. This can be specified by the client when creating a new Nudge via the API, if one is not specified during creation or a Nudge is created via a different method then the API ID can be obtained by querying the API.

Users can be created and managed using the Directory API: Users endpoints and will be referenced in this set of APIs.

 

GET /nudge/

List all Nudges pending or processed in this organisation.

 

Parameters

search: string A search term (you can search by 'name')
limit: integer Number of results to return per page
offset: integer

The initial index from which to return results

 

Response

Returns an object including a list of Nudges.

{
[
   {
      api_id: string,
      person_api_id: string,      // The person to nudge
      nudge_type: string,         // The type of nudge to be sent
      nudge_information: string,  // Based on the nudge type, will include additional information
      created_timestamp: datetime,// When the nudge was created 
      nudge_complete: boolean,    // If this nudge has been process it will be set to true
   }
]
}

 

POST /nudge/

Create a new Nudge.

 

Parameters

None

 

Request Body

{
[
   {
      api_id: string,             // Optional
      person_api_id: string,      // The person to nudge
      nudge_type: string,         // The type of nudge to be sent
      nudge_information: string,  // Based on the nudge type, will include additional information
   }
]
}

 

 

Response

Returns an object including the created Nudge.


   {
      api_id: string,             
      person_api_id: string,      // The person to nudge
      nudge_type: string,         // The type of nudge to be sent
      nudge_information: string,  // Based on the nudge type, will include additional information
      created_timestamp: datetime,// When the nudge was created 
      nudge_complete: boolean,    // If this nudge has been process it will be set to true
   }

 

 

GET /nudge/{ api_id }/

Get a single Nudge.

 

Parameters

None

 

Response

Returns an object for this specific Nudge.

Returns an object including the created Package.


   {
      api_id: string,             // Optional
      person_api_id: string,      // The person to nudge
      nudge_type: string,         // The type of nudge to be sent
      nudge_information: string,  // Based on the nudge type, will include additional information
   }

 

DELETE /nudge/{ api_id }/

Delete a Nudge from the organisation. Nudges that have already been completed cannot be deleted. Nudges will be processed within 30 minutes of being created, unless they are specifically timed or batched based on the nudge_type.

When a Nudge is deleted before being processed it will not be processed by the system.

 

Parameters

None

 

Request

None

 

Response

None

Related articles