Outgoing Webhooks

Endpoint

Outgoing webhook management (supervisor/admin only)

List outgoing webhooks

GET

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

/api/outgoing-webhooks

Supervisor or admin only.

List outgoing webhooks › Responses

Outgoing webhooks

object[]

id

string · uuid · required

name

string · required

url

string · required

secret

string · required

events

required

JSON array of subscribed event type strings

is_active

boolean · required

consecutive_failures

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

created_by

string · uuid

last_triggered_at

string · date-time

last_success_at

string · date-time

Create an outgoing webhook

POST

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

/api/outgoing-webhooks

Supervisor or admin only.

Create an outgoing webhook › Request Body

name

string · minLength: 1 · required

url

string · required

Must start with http:// or https://

secret

string

events

string[]

Valid types: message.received, message.sent, message.status, conversation.created, conversation.resolved, conversation.assigned, contact.created

Create an outgoing webhook › Responses

Webhook created

id

string · uuid · required

name

string · required

url

string · required

secret

string · required

events

required

JSON array of subscribed event type strings

is_active

boolean · required

consecutive_failures

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

created_by

string · uuid

last_triggered_at

string · date-time

last_success_at

string · date-time

POST/api/outgoing-webhooks

curl --request POST \
  --url https://api-chat.bara.my.id/api/outgoing-webhooks \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "url": "url",
  "secret": "secret",
  "events": [
    "string"
  ]
}
'

shell

Example Request Body

{
  "name": "name",
  "url": "url",
  "secret": "secret",
  "events": [
    "string"
  ]
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "url": "url",
  "secret": "secret",
  "events": {},
  "is_active": true,
  "created_by": "00000000-0000-0000-0000-000000000000",
  "last_triggered_at": "2024-08-25T15:00:00Z",
  "last_success_at": "2024-08-25T15:00:00Z",
  "consecutive_failures": 0,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

List available webhook event types

GET

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

/api/outgoing-webhooks/events

Supervisor or admin only.

List available webhook event types › Responses

200

Event type strings

string[]

Delete an outgoing webhook

DELETE

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

/api/outgoing-webhooks/{id}

Supervisor or admin only.

Delete an outgoing webhook › path Parameters

id

string · uuid · required

Delete an outgoing webhook › Responses

Webhook deleted

message

string

id

string · uuid

Update an outgoing webhook

PATCH

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

/api/outgoing-webhooks/{id}

Supervisor or admin only.

Update an outgoing webhook › path Parameters

id

string · uuid · required

Update an outgoing webhook › Request Body

name

string

url

string

secret

string

events

string[]

is_active

boolean

Update an outgoing webhook › Responses

Webhook updated

id

string · uuid · required

name

string · required

url

string · required

secret

string · required

events

required

JSON array of subscribed event type strings

is_active

boolean · required

consecutive_failures

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

created_by

string · uuid

last_triggered_at

string · date-time

last_success_at

string · date-time

PATCH/api/outgoing-webhooks/{id}

curl --request PATCH \
  --url https://api-chat.bara.my.id/api/outgoing-webhooks/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "url": "url",
  "secret": "secret",
  "events": [
    "string"
  ],
  "is_active": true
}
'

shell

Example Request Body

{
  "name": "name",
  "url": "url",
  "secret": "secret",
  "events": [
    "string"
  ],
  "is_active": true
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "url": "url",
  "secret": "secret",
  "events": {},
  "is_active": true,
  "created_by": "00000000-0000-0000-0000-000000000000",
  "last_triggered_at": "2024-08-25T15:00:00Z",
  "last_success_at": "2024-08-25T15:00:00Z",
  "consecutive_failures": 0,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

List deliveries for a webhook

GET

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

/api/outgoing-webhooks/{id}/deliveries

Supervisor or admin only. Paginated, newest first.

List deliveries for a webhook › path Parameters

id

string · uuid · required

List deliveries for a webhook › query Parameters

page

integer

Default: 1

per_page

integer · max: 100

Default: 50

List deliveries for a webhook › Responses

200

Webhook deliveries

object[]

id

string · uuid · required

webhook_id

string · uuid · required

event_type

string · required

payload

required

status

string · enum · required

Enum values:

pending

success

failed

attempt

integer · required

max_attempts

integer · required

created_at

string · date-time · required

http_status

integer

response_body

string

error_message

string

next_retry_at

string · date-time

completed_at

string · date-time

Send a test event to the webhook

POST

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

/api/outgoing-webhooks/{id}/test

Supervisor or admin only. Sends a test payload and returns the response.

Send a test event to the webhook › path Parameters

id

string · uuid · required

Send a test event to the webhook › Responses

Test result

success

boolean

http_status

integer

response_body

string

error

string

SLA Campaigns

OmniStream CRM API

Outgoing Webhooks

Endpoint

Outgoing webhook management (supervisor/admin only)

List outgoing webhooks

GET

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

/api/outgoing-webhooks

Supervisor or admin only.

List outgoing webhooks › Responses

Outgoing webhooks

object[]

id

string · uuid · required

name

string · required

url

string · required

secret

string · required

events

required

JSON array of subscribed event type strings

is_active

boolean · required

consecutive_failures

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

created_by

string · uuid

last_triggered_at

string · date-time

last_success_at

string · date-time

Create an outgoing webhook

POST

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

/api/outgoing-webhooks

Supervisor or admin only.

Create an outgoing webhook › Request Body

name

string · minLength: 1 · required

url

string · required

Must start with http:// or https://

secret

string

events

string[]

Valid types: message.received, message.sent, message.status, conversation.created, conversation.resolved, conversation.assigned, contact.created

Create an outgoing webhook › Responses

Webhook created

id

string · uuid · required

name

string · required

url

string · required

secret

string · required

events

required

JSON array of subscribed event type strings

is_active

boolean · required

consecutive_failures

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

created_by

string · uuid

last_triggered_at

string · date-time

last_success_at

string · date-time

POST/api/outgoing-webhooks

curl --request POST \
  --url https://api-chat.bara.my.id/api/outgoing-webhooks \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "url": "url",
  "secret": "secret",
  "events": [
    "string"
  ]
}
'

shell

Example Request Body

{
  "name": "name",
  "url": "url",
  "secret": "secret",
  "events": [
    "string"
  ]
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "url": "url",
  "secret": "secret",
  "events": {},
  "is_active": true,
  "created_by": "00000000-0000-0000-0000-000000000000",
  "last_triggered_at": "2024-08-25T15:00:00Z",
  "last_success_at": "2024-08-25T15:00:00Z",
  "consecutive_failures": 0,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

List available webhook event types

GET

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

/api/outgoing-webhooks/events

Supervisor or admin only.

List available webhook event types › Responses

200

Event type strings

string[]

Delete an outgoing webhook

DELETE

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

/api/outgoing-webhooks/{id}

Supervisor or admin only.

Delete an outgoing webhook › path Parameters

id

string · uuid · required

Delete an outgoing webhook › Responses

Webhook deleted

message

string

id

string · uuid

Update an outgoing webhook

PATCH

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

/api/outgoing-webhooks/{id}

Supervisor or admin only.

Update an outgoing webhook › path Parameters

id

string · uuid · required

Update an outgoing webhook › Request Body

name

string

url

string

secret

string

events

string[]

is_active

boolean

Update an outgoing webhook › Responses

Webhook updated

id

string · uuid · required

name

string · required

url

string · required

secret

string · required

events

required

JSON array of subscribed event type strings

is_active

boolean · required

consecutive_failures

integer · required

created_at

string · date-time · required

updated_at

string · date-time · required

created_by

string · uuid

last_triggered_at

string · date-time

last_success_at

string · date-time

PATCH/api/outgoing-webhooks/{id}

curl --request PATCH \
  --url https://api-chat.bara.my.id/api/outgoing-webhooks/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "url": "url",
  "secret": "secret",
  "events": [
    "string"
  ],
  "is_active": true
}
'

shell

Example Request Body

{
  "name": "name",
  "url": "url",
  "secret": "secret",
  "events": [
    "string"
  ],
  "is_active": true
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "url": "url",
  "secret": "secret",
  "events": {},
  "is_active": true,
  "created_by": "00000000-0000-0000-0000-000000000000",
  "last_triggered_at": "2024-08-25T15:00:00Z",
  "last_success_at": "2024-08-25T15:00:00Z",
  "consecutive_failures": 0,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

List deliveries for a webhook

GET

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

/api/outgoing-webhooks/{id}/deliveries

Supervisor or admin only. Paginated, newest first.

List deliveries for a webhook › path Parameters

id

string · uuid · required

List deliveries for a webhook › query Parameters

page

integer

Default: 1

per_page

integer · max: 100

Default: 50

List deliveries for a webhook › Responses

200

Webhook deliveries

object[]

id

string · uuid · required

webhook_id

string · uuid · required

event_type

string · required

payload

required

status

string · enum · required

Enum values:

pending

success

failed

attempt

integer · required

max_attempts

integer · required

created_at

string · date-time · required

http_status

integer

response_body

string

error_message

string

next_retry_at

string · date-time

completed_at

string · date-time

Send a test event to the webhook

POST

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

/api/outgoing-webhooks/{id}/test

Supervisor or admin only. Sends a test payload and returns the response.

Send a test event to the webhook › path Parameters

id

string · uuid · required

Send a test event to the webhook › Responses

Test result

success

boolean

http_status

integer

response_body

string

error

string

SLA Campaigns