Question 1

How install Changelogfy widget

Accepted Answer

| For use Changelogfy with VueJS or ReactJS, follow link's bellow:

For normal installation, please continue with tutorial bellow:

To install our beautiful widget on your website, the first step is to choose the element that you will use as selector, it can be a button, width, div or even a span. This selector will be used to open or close the widget, as in the example below:

<div class="changelogfy-widget"></div>

The next step is to insert our javascript code, it must be inserted inside the tag or before closing the tag.

<script>
    let CLF_config = {
        selector: ".changelogfy-widget",
        app_id: "APP_ID"
    };
</script>
<script async src="https://widget.changelogfy.com/index.js"></script>

||| Do not host our index.js in your servers! The "selector": ".changelogfy-widget" ensures that this code will find the element with changelogfy-widget class and insert the badge into that element.

Single page application

Some applications that dynamically reload content (Angular, React, Vue, Ember, etc) mean you'll probably want to initialize the widget within your JavaScript code.

To do this, you need to instantiate and call the init method, as in the example below: ```

Question 2

Custom domain

Accepted Answer

Changelogfy allows you to use a custom domain on your changelog page.

||| Important: This feature is available for paid plans only.

To use the custom domain on your page, the first step is to access public page settings from the Changelogfy admin panel.

Changelog Settings

After you enter the domain you want to use for your Changelog page, the next step is to create a CNAME record pointing to custom.changelogfy.com, as in the example below:

Changelog Page Cname DNS

SSL

We create SSL certificates automatically for custom domains. Just create the CNAME record and we'll do the rest.

Question 3

Identify your users

Accepted Answer

To identify your users through our javascript SDK, make sure you have already installed our widget by following the tutorial below:

👉 Install Widget

⚠️ !!! Important: The user identification feature is only available in the Pro plan

In your script you need to send the data parameter, with the user information.

<script>
  var CLF_config = {
    selector: ".changelogfy-widget", //required
    app_id: "APP_ID", // required
    data: {
      user_id: '30631b96-3add-4f9a-addc-9f4cd1cf5915', // required - userId in your software
      user_name: 'User Name', // optional
      user_email: 'user@email.com', // optional
      custom_data: {
          'Job_Role': 'CEO', // Example data
          'Plan': 'Pro', // Example data
          'teammates': '4', // Example data 
          'Monthly_Spend': '50 USD' // Example data
      }
    }
  };
</script>

ℹ️ !!! Note: User updates are not processed in real time, it may take a few minutes for the information to be updated on your dashboard.

Question 4

How to enable slack integration

Accepted Answer

||| Important: This feature is available for paid plans only. For enable Slack integration with Changelogfy, first you need go to Settings section.

In the integrations section, look for Slack and click Connect, as in the example below:

Select what channel you want receive Slack notification.

After select the channel click in Authorize.

When you publish new posts in changelog your audience will receive new Slack notification same image bellow.

Contact us if you have any question or problem at talk@changelogfy.com

Question 5

Posts

Accepted Answer

(Get) - Index

https://changelogfy.com/api/projects/{app_id}/posts

Params:

app_id - ${color}#ff2600 page - optional

This method get posts from your project with pagination, 5 posts per page.

Response:

``` { "currentpage":1, "data":[ { "id":1356, "projectid":2, "title":"New Import Source: GitHub Releases 🎊", "body":"

From now on you can import GitHub releases into Changelogfy.

This can happen in two ways:

A simple import.
Automatic import, this means that every time a new GitHub Release is released it will be automatically imported into your Changelogfy project.

Warning: For now this feature is only available for public repositories on GitHub.

Best,

Paulo

", "slug":"new-import-source-github-releases", "userid":2, "labelid":4, "published":1, "publishedat":"2019-09-11 01:37:00", "fixedontop":false, "overrideurl":null, "read":false, "label":{ "id":4, "name":"New", "color":"#32AD03", "projectid":2 }, "user":{ "id":2, "name":"Paulo", "avatar":"https://changelogfy.s3.amazonaws.com/users/avatar/73dc66d68677183de1a12db71112c96bffc82db1b68af5611c094afac30e9841.png", "job":"Founder" } }, { "id":1325, "projectid":2, "title":"New JavaScript SDK", "

Question 6

How to get my invoices

Accepted Answer

We like to be as clear and transparent as possible with our customers.

That's why you can redeem your invoice anytime and anytime by simply accessing system settings. Changelogfy Settings

Click on "Invoices" in the setup side menu. Setting System

Your list of invoices will be displayed, to download just click on the desired invoice. Download Invoice

Frequently Read Articles

Browse All Categories