Noticeable
Prev  Marketing  Next

Noticeable

The Noticeable modules allow you to create, update, retrieve, and delete the posts in your Noticeable account.

Getting Started with Noticeable

Prerequisites

  • A Noticeable account

In order to use Noticeable with {{Make}}, it is necessary to have a Noticeable account. If you do not have one, you can create a Noticeable account at noticeable.io/register.

[Note] Note

The module dialog fields that are displayed in bold (in the {{Make}} scenario, not in this documentation article) are mandatory!
Connecting Noticeable to {{Make}}

To connect your Noticeable account to {{Make}} you need to obtain the API Key from your Noticeable account and insert it in the Create a connection dialog in the {{Make}} module.

  1. Login to your Noticeable account.

  2. Click API > Eye Icon (61f2743aeb4ef.png).

    61f2743c1cc96.gif

  3. Copy the API Key to your clipboard.

    61f2743e5a6d3.png

  4. Go to {{Make}} and open the Noticeable module's Create a connection dialog.

    61f2743f8bf11.gif

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

  6. In the API Key field, enter the API key copied in step 3 and click Continue.

The connection has been established.

Actions
Get a Post

Returns the details about a specified post.

Connection

Establish a connection to your Noticeable account.

Project ID

Select the Project ID whose post details you want to retrieve.

Post ID

Select the Post ID whose details you want to retrieve.
Create a Post

Creates a new post on a project.

Connection

Establish a connection to your Noticeable account.

Project ID

Select the Project ID for which you want to create a post.

Labels

Add the labels. For example, Announcement, Improvement.

Content

Enter the post content. Markdown files are supported.

Publication Time

Enter the time when the post is published.

Title

Enter a name for the post.

Forward to Webhooks

Select the checkbox to forward the post to webhooks upon publishing.

Is Draft

Select the checkbox if the post is a draft.

Hidden Comments

Select the checkbox to view the hidden comments.

Reactions

Select the checkbox to view the reactions.

Slug

Enter the friendly URL address to the post. Format must match pattern /(^[a-zA-Z0-9-]+$)/.

Full Name

Enter the author's full name.

Email

Enter the author's email address.

Job Title

Enter the author's position in the company.

Excerpt

Enter a short extract of the post content. The content should be less than or equal to 240 characters.

Segments

Enter a list of segments as filters used to target specific users.

Featured Image

Enter the URL address of the image that represents the contents, mood, or theme of the post.
Update a Post

Updates a post in a specified project.

Connection

Establish a connection to your Noticeable account.

Project ID

Select the Project ID for which you want to create a post.

Post ID

Select the Post ID whose details you want to update.

Labels

Add the labels. For example, Announcement, Improvement.

Content

Enter the post content. Markdown files are supported.

Publication Time

Enter the time when the post is published.

Title

Enter a name for the post.

Forward to Webhooks

Select the checkbox to forward the post to webhooks upon publishing.

Is Draft

Select the checkbox if the post is a draft.

Hidden Comments

Select the checkbox to view the hidden comments.

Reactions

Select the checkbox to view the reactions.

Slug

Enter the friendly URL address to the post. Format must match pattern /(^[a-zA-Z0-9-]+$)/.

Full Name

Enter the author's full name.

Email

Enter the author's email address.

Job Title

Enter the author's position in the company.

Excerpt

Enter a short extract of the post content. The content should be less than or equal to 240 characters.

Segments

Enter a list of segments as filters used to target specific users.

Featured Image

Enter the URL address of the image that represents the contents, mood, or theme of the post.
Delete a Post

Deletes a post in a specified project.

Connection

Establish a connection to your Noticeable account.

Project ID

Select the Project ID whose post you want to delete.

Post ID

Select the Post ID you want to delete.
Execute a GraphQL Query

Performs an arbitrary authorized GraphQL query.

Connection

Establish a connection to your Noticeable account.

Method

Select the HTTP method you want to use:

GET

to retrieve information for an entry.

POST

to create a new entry.

Query

Enter the complete GraphQL query. For example,

{ organization 
    { projects(first: 10) { pageInfo { hasNextPage } edges {
 node { name posts(last: 10) { edges { node { title permalink
 } } } } } } } }
[Note] Note

For the list of available endpoints, refer to the Noticeable GraphQL Queries documentation.

Variable Data Source

Select the variable data source type:

  • Forms

  • Collection

Variables

Add the variables:

Key

Enter the Key details in JSON format.

Value

Enter the key value in JSON format.
Example - Get Projects

The following GraphQL query returns all the customers from your Noticeable account:

Method:

GET

Query:

{organization { projects(first: 10) { pageInfo { hasNextPage } edges { node { name posts(last: 10) { edges { node { title permalink } } } } } } } } }

61f27441d80b3.png

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

In our example, 2 projects were returned:

61f27443102cc.png
Prev  Up  Next
Nextcloud  Home  PeerBoard