• Documentation >
• Apps >
• Productivity >
• Papyrs

Papyrs

The Papyrs modules allow you to watch, create, update, list, retrieve, and delete the people, pages, text boxes, and heading widgets in your Papyrs account.

Getting Started with Papyrs

Prerequisites

• A Papyrs account

In order to use Papyrs with Ibexa Connect, it is necessary to have a Papyrs account. If you do not have one, you can create a Papyrs account at register.papyrs.com/accounts/register/.

Connecting Papyrs to Ibexa Connect

To connect your Papyrs account to Ibexa Connect you need to obtain the API Key from your Papyrs account and insert it in the Create a connection dialog in the Ibexa Connect module.

1. Log in to your Papyrs account and open your Dashboard.

2. Click Your Intranet > Settings > Integrations & SSO. Navigate to API Section and click Generate Token.

3. Copy the access token to your clipboard.

4. Go to Ibexa Connect and open the Papyrs module's Create a connection dialog.

5. In the Connection name field, enter a name for the connection.

6. In the API Token field, enter the API token copied in step 3.

7. In the Subdomain field, enter your account's subdomain name. For example, if your account's URL address is www.xyz.papyrs.com then your subdomain is xyz. Click Continue.

The connection has been established.

People

Watch People

Triggers when new people are joined.

Subsite	Select the subsite whose people you want to list. For example, About Us.
Limit	Set the maximum number of people Ibexa Connect should return during one scenario execution cycle

Delete a User

Deletes a page by its ID.

Subsite	Select the subsite whose users you want to delete. For example, About Us.
User ID	Select the User ID you want to delete.

List People

Lists all people. Ordered by join (newest page first).

Subsite	Select the subsite whose people you want to list. For example, About Us.
Limit	Set the maximum number of people Ibexa Connect should return during one scenario execution cycle.

Pages

Watch Pages

Triggers when new pages are created.

Subsite	Select the subsite whose pages you want to list. For example, About Us.
Limit	Set the maximum number of pages Ibexa Connect should return during one scenario execution cycle.

Get a Page

Retrieves a page

Subsite	Select the subsite whose page details you want to retrieve. For example, About Us.
User ID	Select the Page ID whose details you want to retrieve. For example, Team.

Delete a Page

Deletes a page by its ID.

Subsite	Select the subsite whose page details you want to delete. For example, About Us.
User ID	Select the Page ID you want to delete. For example, Team.

List Page

Lists all existing pages. Ordered by creation date (newest page first).

Subsite	Select the subsite whose page you want to list. For example, About Us.
Limit	Set the maximum number of pages Ibexa Connect should return during one scenario execution cycle.

Text Boxes

Create a Text Box

Creates a new text box on a page.

Subsite	Select the subsite on whose page you want to create a text box. For example, About Us.
Page ID	Select the Page ID in which you want to create a text box.
Format	Select the text format: HTML Plain Text
Value	Enter the text for the text box.

Get a Text Box

Retrieves information about the selected text box.

Subsite	Select the subsite whose page's text box details you want to retrieve. For example, /About Us.
Page ID	Select the Page ID whose text box details you want to get. For example, Team.
Widget ID	Select the page Widget ID whose details you want to retrieve. For example, Leadership.

Update a Text Box

Updates an existing text box.

Subsite	Select the subsite whose page's text box details you want to update. For example, About Us.
Page ID	Select the Page ID whose text box details you want to update.
Widget ID	Select the Widget ID (text box) whose details you want to update.
Format	Select the text format: HTML Plain Text
Value	Enter the text for the text box.

Delete a Text Box

Deletes an existing text box on a page.

Subsite	Select the subsite whose page's text box you want to delete. For example, About Us.
Page ID	Select the Page ID whose text box you want to delete.
Widget ID	Select the Widget ID (text box) you want to delete.

Heading Widgets

Create a Heading Widget

Creates a heading widget on a page.

Subsite	Select the subsite on whose page you want to create a heading widget. For example, About Us.
Page ID	Select the Page ID in which you want to create a heading widget. For example, Team.
Format	Select the text format: HTML Plain Text
Value	Enter the heading text.

Get a Heading Widget

Retrieves information about a selected heading widget.

Subsite	Select the subsite whose page's heading widget details you want to retrieve. For example, About Us.
Page ID	Select the Page ID whose heading widget details you want to retrieve. For example, Team.
Widget ID	Select the Widget ID whose details you want to retrieve.

Update a Heading Widget

Updates an existing heading widget.

Subsite	Select the subsite whose page's heading widget details you want to update. For example, About Us.
Page ID	Select the Page ID whose heading widget details you want to update. For example, Team.
Widget ID	Select the Widget ID whose details you want to update.
Format	Select the text format: HTML Plain Text
Value	Enter the heading text for the widget.

Delete a Heading Widget

Deletes an existing heading widget on a page.

Subsite	Select the subsite whose page's heading widget details you want to delete. For example, About Us.
Page ID	Select the Page ID whose heading widget details you want to delete. For example, Team.
Widget ID	Select the Widget ID whose details you want to delete.

Feeds

Post to a Discussion Stream on a Page

Posts a comment to any page with a discussion widget.

Subsite	Select the subsite on whose page you want to post a message in the discussion stream. For example, About Us.
Page ID	Select the Page ID on whose discussion stream you want to post the message. For example, Team.
Message	Enter the message text you want to post.

Other

Make an API Call

Performs an arbitrary authorized API call.

URL	Enter a path relative to https://<YourSubdomain>.papyrs.com/. For example: /@<Subsite>/api/v1/pages/all For the list of available endpoints, refer to the Papyrs API Documentation.
Method	Select the HTTP method you want to use: GETto retrieve information for an entry. POSTto create a new entry. PUTto update/replace an existing entry. PATCHto make a partial entry update. DELETEto delete an entry.
Headers	Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String	Enter the request query string.
Body	Enter the body content for your API call.

Example of Use - Get All People

The following API call returns all the people from your Papyrs account:

URL:/api/v1/people/all/

Method:GET

Matches of the search can be found in the module's Output under Bundle > Body.

In our example, 4 people were returned: