Skip to main content
GET
/
hooks
const axios = require('axios');
const WebhooksApiFp = require('@alohi/faxplus-api').WebhooksApiFp;
const Configuration = require('@alohi/faxplus-api').Configuration;

const config = new Configuration({
    accessToken: accessToken,
    basePath: 'https://restapi.fax.plus/v3',
    // Header required only when using the OAuth2 token scheme
    baseOptions: {
        headers: {
          "x-fax-clientid": clientId,
        }
    }
});

async function getWebhooks() {
    const reqParams = {
        "event": 'fax_received'
    }
    const req = await WebhooksApiFp(config).getWebhooks(reqParams);
    const resp = await req(axios);
}

getWebhooks()

{
  "data": [
    {
      "target": "http://myapp.com/fax_received",
      "event": "fax_received"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://apidoc.fax.plus/llms.txt

Use this file to discover all available pages before exploring further.

const axios = require('axios');
const WebhooksApiFp = require('@alohi/faxplus-api').WebhooksApiFp;
const Configuration = require('@alohi/faxplus-api').Configuration;

const config = new Configuration({
    accessToken: accessToken,
    basePath: 'https://restapi.fax.plus/v3',
    // Header required only when using the OAuth2 token scheme
    baseOptions: {
        headers: {
          "x-fax-clientid": clientId,
        }
    }
});

async function getWebhooks() {
    const reqParams = {
        "event": 'fax_received'
    }
    const req = await WebhooksApiFp(config).getWebhooks(reqParams);
    const resp = await req(axios);
}

getWebhooks()

Authorizations

​
Authorization
string
header
required

OAuth2 Authorization Grant

Query Parameters

​
event
enum<string>
required

Webhook event type

Available options:
fax_received,
fax_sent,
fax_page_received

Response

Response containing a list of currently registered webhooks

List of webhooks

​
data
object[]