Integrations

Endpoint

Channel integration settings

List all channel integrations

GET

https://api-chat.bara.my.id

/api/integrations

Admin or supervisor only.

List all channel integrations › Responses

List of integrations

object[]

id

string · uuid · required

channel

string · required

whatsapp, instagram, email, or messenger

is_active

boolean · required

config

object · required

Channel configuration (sensitive fields masked)

created_at

string · date-time · required

updated_at

string · date-time · required

division_id

string · uuid

Get a single integration by channel

GET

https://api-chat.bara.my.id

/api/integrations/{channel}

Returns empty config if not yet configured.

Get a single integration by channel › path Parameters

channel

string · enum · required

Enum values:

instagram

messenger

Get a single integration by channel › Responses

Integration details (or default empty config)

id

string · uuid · required

channel

string · required

whatsapp, instagram, email, or messenger

is_active

boolean · required

config

object · required

Channel configuration (sensitive fields masked)

created_at

string · date-time · required

updated_at

string · date-time · required

division_id

string · uuid

Create or update an integration (upsert)

PUT

https://api-chat.bara.my.id

/api/integrations/{channel}

Admin only. Merges config — masked values are not overwritten.

Create or update an integration (upsert) › path Parameters

channel

string · enum · required

Enum values:

instagram

messenger

Create or update an integration (upsert) › Request Body

is_active

boolean

config

object

division_id

string · uuid

Create or update an integration (upsert) › Responses

Integration updated

id

string · uuid · required

channel

string · required

whatsapp, instagram, email, or messenger

is_active

boolean · required

config

object · required

Channel configuration (sensitive fields masked)

created_at

string · date-time · required

updated_at

string · date-time · required

division_id

string · uuid

Delete an integration

DELETE

https://api-chat.bara.my.id

/api/integrations/{channel}

Admin only.

Delete an integration › path Parameters

channel

string · enum · required

Enum values:

instagram

messenger

Delete an integration › Responses

Integration deleted

message

string

channel

string

List integration accounts

GET

https://api-chat.bara.my.id

/api/integrations/accounts

Admin or supervisor only. Optionally filter by channel.

List integration accounts › query Parameters

channel

string · enum

Enum values:

instagram

messenger

List integration accounts › Responses

List of integration accounts

object[]

id

string · uuid · required

channel

string · required

whatsapp, instagram, email, or messenger

account_key

string · required

Unique key within a channel (e.g. wa-123456789)

display_name

string · required

is_active

boolean · required

is_default

boolean · required

config

object · required

Account configuration (sensitive fields masked)

created_at

string · date-time · required

updated_at

string · date-time · required

division_id

string · uuid

verify_token

string

webhook_url

string

Computed webhook URL for this account

Create an integration account

POST

https://api-chat.bara.my.id

/api/integrations/accounts

Admin only. For WhatsApp, auto-registers and subscribes the phone number.

Create an integration account › Request Body

channel

string · required

whatsapp, instagram, email, or messenger

account_key

string

Required for non-WhatsApp channels. Auto-derived from phone_number_id for WhatsApp.

display_name

string

is_active

boolean

Default: false

is_default

boolean

Default: false

division_id

string · uuid

config

object

Create an integration account › Responses

Account created

id

string · uuid · required

channel

string · required

whatsapp, instagram, email, or messenger

account_key

string · required

Unique key within a channel (e.g. wa-123456789)

display_name

string · required

is_active

boolean · required

is_default

boolean · required

config

object · required

Account configuration (sensitive fields masked)

created_at

string · date-time · required

updated_at

string · date-time · required

division_id

string · uuid

verify_token

string

webhook_url

string

Computed webhook URL for this account

POST/api/integrations/accounts

curl --request POST \
  --url https://api-chat.bara.my.id/api/integrations/accounts \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel": "channel",
  "account_key": "account_key",
  "display_name": "display_name",
  "is_active": false,
  "is_default": false,
  "division_id": "00000000-0000-0000-0000-000000000000",
  "config": {}
}
'

shell

Example Request Body

{
  "channel": "channel",
  "account_key": "account_key",
  "display_name": "display_name",
  "is_active": false,
  "is_default": false,
  "division_id": "00000000-0000-0000-0000-000000000000",
  "config": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "channel": "channel",
  "account_key": "account_key",
  "display_name": "display_name",
  "is_active": true,
  "is_default": true,
  "division_id": "00000000-0000-0000-0000-000000000000",
  "config": {},
  "verify_token": "verify_token",
  "webhook_url": "webhook_url",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get an integration account by ID

GET

https://api-chat.bara.my.id

/api/integrations/accounts/{id}

Get an integration account by ID › path Parameters

id

string · uuid · required

Get an integration account by ID › Responses

Integration account details

id

string · uuid · required

channel

string · required

whatsapp, instagram, email, or messenger

account_key

string · required

Unique key within a channel (e.g. wa-123456789)

display_name

string · required

is_active

boolean · required

is_default

boolean · required

config

object · required

Account configuration (sensitive fields masked)

created_at

string · date-time · required

updated_at

string · date-time · required

division_id

string · uuid

verify_token

string

webhook_url

string

Computed webhook URL for this account

Delete an integration account

DELETE

https://api-chat.bara.my.id

/api/integrations/accounts/{id}

Admin only. If deleted account was default, another account is promoted.

Delete an integration account › path Parameters

id

string · uuid · required

Delete an integration account › Responses

Account deleted

message

string

id

string · uuid

Update an integration account

PATCH

https://api-chat.bara.my.id

/api/integrations/accounts/{id}

Admin only. Merges config — masked values are not overwritten.

Update an integration account › path Parameters

id

string · uuid · required

Update an integration account › Request Body

account_key

string

display_name

string

is_active

boolean

is_default

boolean

division_id

string · uuid

config

object

Update an integration account › Responses

Account updated

id

string · uuid · required

channel

string · required

whatsapp, instagram, email, or messenger

account_key

string · required

Unique key within a channel (e.g. wa-123456789)

display_name

string · required

is_active

boolean · required

is_default

boolean · required

config

object · required

Account configuration (sensitive fields masked)

created_at

string · date-time · required

updated_at

string · date-time · required

division_id

string · uuid

verify_token

string

webhook_url

string

Computed webhook URL for this account

PATCH/api/integrations/accounts/{id}

curl --request PATCH \
  --url https://api-chat.bara.my.id/api/integrations/accounts/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_key": "account_key",
  "display_name": "display_name",
  "is_active": true,
  "is_default": true,
  "division_id": "00000000-0000-0000-0000-000000000000",
  "config": {}
}
'

shell

Example Request Body

{
  "account_key": "account_key",
  "display_name": "display_name",
  "is_active": true,
  "is_default": true,
  "division_id": "00000000-0000-0000-0000-000000000000",
  "config": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "channel": "channel",
  "account_key": "account_key",
  "display_name": "display_name",
  "is_active": true,
  "is_default": true,
  "division_id": "00000000-0000-0000-0000-000000000000",
  "config": {},
  "verify_token": "verify_token",
  "webhook_url": "webhook_url",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Set an integration account as the default for its channel

POST

https://api-chat.bara.my.id

/api/integrations/accounts/{id}/set-default

Admin only. Clears the default flag from all other accounts in that channel.

Set an integration account as the default for its channel › path Parameters

id

string · uuid · required

Set an integration account as the default for its channel › Responses

Account set as default

id

string · uuid · required

channel

string · required

whatsapp, instagram, email, or messenger

account_key

string · required

Unique key within a channel (e.g. wa-123456789)

display_name

string · required

is_active

boolean · required

is_default

boolean · required

config

object · required

Account configuration (sensitive fields masked)

created_at

string · date-time · required

updated_at

string · date-time · required

division_id

string · uuid

verify_token

string

webhook_url

string

Computed webhook URL for this account

Fetch WhatsApp account health from Meta Graph API

GET

https://api-chat.bara.my.id

/api/integrations/accounts/{id}/whatsapp-status

Admin only. Returns phone number status, WABA info, and subscribed apps status in parallel.

Fetch WhatsApp account health from Meta Graph API › path Parameters

id

string · uuid · required

Fetch WhatsApp account health from Meta Graph API › Responses

WhatsApp account status

account_id

string · uuid

display_name

string

phone_number_id

string

waba_id

string

healthy

boolean

phone_number

object

waba

object

subscribed_apps

object

subscribed_ok

boolean

GET

https://api-chat.bara.my.id

/api/integrations/whatsapp/embedded-signup-config

Admin only. Returns Meta App ID and config ID for the Facebook JS SDK.

Embedded signup config

app_id

string

config_id

string

POST

https://api-chat.bara.my.id

/api/integrations/whatsapp/embedded-signup

Admin only. Exchanges the authorization code from the WhatsApp Embedded Signup JS SDK flow for an access token, upserts the integration account, and subscribes the phone number to WABA webhooks.

code

string · required

Authorization code from the Embedded Signup JS SDK

waba_id

string · required

phone_number_id

string · required

Account connected

success

boolean

account_key

string

display_name

string

waba_id

string

phone_number_id

string

Get Instagram OAuth app config

GET

https://api-chat.bara.my.id

/api/integrations/instagram/auth-config

Admin only. Returns the Instagram App ID for the OAuth flow.

Get Instagram OAuth app config › Responses

Instagram app config

app_id

string

Connect Instagram account via OAuth

POST

https://api-chat.bara.my.id

/api/integrations/instagram/connect

Admin only. Exchanges an authorization code for a long-lived token, fetches the user profile, and saves the Instagram integration account.

Connect Instagram account via OAuth › Request Body

code

string · required

Authorization code from Instagram Login OAuth popup

redirect_uri

string · required

Must exactly match the redirect_uri used in the OAuth dialog

Connect Instagram account via OAuth › Responses

Account connected

success

boolean

object[]

Get Messenger OAuth app config

GET

https://api-chat.bara.my.id

/api/integrations/messenger/auth-config

Admin only. Returns the Meta App ID for the Facebook Login flow.

Get Messenger OAuth app config › Responses

Messenger app config

app_id

string

config_id

string

POST

https://api-chat.bara.my.id

/api/integrations/messenger/connect

Admin only. Exchanges the authorization code for a long-lived user token, fetches the user's Facebook Pages, and returns them for selection. Pass the returned user_token and selected pages to POST /api/integrations/messenger/pages.

code

string · required

Authorization code from Facebook Login OAuth popup

redirect_uri

string · required

Must exactly match the redirect_uri used in the OAuth dialog

Pages available for selection

object[]

user_token

string

Long-lived user token — pass back to /messenger/pages

POST

https://api-chat.bara.my.id

/api/integrations/messenger/pages

Admin only. For each selected page: fetches the Page Access Token, subscribes the page to messaging webhooks, and creates an IntegrationAccount.

object[] · required

user_token

string · required

Long-lived user token from POST /messenger/connect

Pages connected

success

boolean

object[]

Disconnect a Messenger page

POST

https://api-chat.bara.my.id

/api/integrations/messenger/disconnect/{account_id}

Admin only. Unsubscribes the page from webhooks and deactivates the account.

Disconnect a Messenger page › path Parameters

account_id

string · uuid · required

Disconnect a Messenger page › Responses

Page disconnected

success

boolean

id

string

GET

https://api-chat.bara.my.id

/api/integrations/messenger/{account_id}/persistent-menu

Admin only. Fetches the current persistent menu from Meta Graph API.

account_id

string · uuid · required

Persistent menu from Meta

POST

https://api-chat.bara.my.id

/api/integrations/messenger/{account_id}/persistent-menu

Admin only. Pass delete: true to remove the menu instead.

account_id

string · uuid · required

persistent_menu

Meta persistent_menu array. Required unless delete is true.

delete

boolean

If true, deletes the persistent menu instead of setting it.

Menu set or deleted

success

boolean

deleted

boolean

Campaigns Activity Logs

Integrations

List all channel integrations

List all channel integrations › Responses

Get a single integration by channel

Get a single integration by channel › path Parameters

Get a single integration by channel › Responses

Create or update an integration (upsert)

Create or update an integration (upsert) › path Parameters

Create or update an integration (upsert) › Request Body

Create or update an integration (upsert) › Responses

Delete an integration

Delete an integration › path Parameters

Delete an integration › Responses

List integration accounts

List integration accounts › query Parameters

List integration accounts › Responses

Create an integration account

Create an integration account › Request Body

Create an integration account › Responses

Get an integration account by ID

Get an integration account by ID › path Parameters

Get an integration account by ID › Responses

Delete an integration account

Delete an integration account › path Parameters

Delete an integration account › Responses

Update an integration account

Update an integration account › path Parameters

Update an integration account › Request Body

Update an integration account › Responses

Set an integration account as the default for its channel

Set an integration account as the default for its channel › path Parameters

Set an integration account as the default for its channel › Responses

Fetch WhatsApp account health from Meta Graph API

Fetch WhatsApp account health from Meta Graph API › path Parameters

Fetch WhatsApp account health from Meta Graph API › Responses

Get WhatsApp Embedded Signup config

Get WhatsApp Embedded Signup config › Responses

Complete WhatsApp Embedded Signup

Complete WhatsApp Embedded Signup › Request Body

Complete WhatsApp Embedded Signup › Responses

Get Instagram OAuth app config

Get Instagram OAuth app config › Responses

Connect Instagram account via OAuth

Connect Instagram account via OAuth › Request Body

Connect Instagram account via OAuth › Responses

Get Messenger OAuth app config

Get Messenger OAuth app config › Responses

Connect Messenger via Facebook Login OAuth

Connect Messenger via Facebook Login OAuth › Request Body

Connect Messenger via Facebook Login OAuth › Responses

Subscribe selected Facebook Pages to Messenger webhooks

Subscribe selected Facebook Pages to Messenger webhooks › Request Body

Subscribe selected Facebook Pages to Messenger webhooks › Responses

Disconnect a Messenger page

Disconnect a Messenger page › path Parameters

Disconnect a Messenger page › Responses

Get Messenger persistent menu

Get Messenger persistent menu › path Parameters

Get Messenger persistent menu › Responses

Set or delete Messenger persistent menu

Set or delete Messenger persistent menu › path Parameters

Set or delete Messenger persistent menu › Request Body

Set or delete Messenger persistent menu › Responses