Resources

Whispir API Resources

This section contains specific detail about how Whispir’s API has been designed, and contains resources and best practices about how best to integrate Whispir’s API into developer applications.

Resource Relationship Model

This section shows the relationships between the Resources within Whispir's API.

Whispir's API makes available the following resources for application clients to retrieve, update or delete:

Resource Type

Description

Company Workspace

The Company Workspace is the parent entity and the root element of the API that instructs the API user on all other functions that they have permission to access.

Workspaces

Workspaces within Whispir's API are the silos of information. 

Each workspace contains various other API resources and must be referenced in order to specify the information that is being requested.

Messages

The messages resource allows the application client to create and send new messages, update draft versions of existing messages, and archive messages on the platform.

Message Status

The message status resource allows the application client to retrieve the real-time status information of a specified message.

Message Responses The message responses resource allows the application client to retrieve any replies to the specified message.

Contacts

The contacts resource allows application clients to configure recipients to messages, import and export recipient information, and perform updates.

Message Templates

The message template resource allows application clients to create new, or retrieve and update existing message templates within Whispir.

Response Rules

The response rules resource allows application clients to create new, or retrieve and update existing response rules within Whispir.

Distribution Lists

The distribution list resource allows application clients to create new, or retrieve and update existing distribution lists within Whispir.

Scenarios

The Scenario resource allows application developers to create ‘ready to send’ messages that contain the appropriate message content and message recipients for users to invoke quickly and easily. 

Events

The events resource allows application clients to create new, or retrieve and update existing events.  Each event has an event type that is defined using the Event Types resource.

Users

This resource identifies the Users of Whispir's API.  Users exist independent of the workspaces within an account.  Using this resource, application clients can retrieve, create, update or delete API users.