## Description When working with webhooks, it's easy to lose track of which URL is which. Adding a `name` (optional) column to the webhook model is a straight-forward solution to make it significantly easier to identify webhooks. ## Type of change - [x] New feature (non-breaking change which adds functionality) ## How Has This Been Tested? Model and controller specs, and also running in production over several months without any issues. | Before | After | | --- | --- | | <img width="949" height="990" alt="image copy 3" src="https://github.com/user-attachments/assets/6b33c072-7d16-4a9c-a129-f9c0751299f5" /> | <img width="806" height="941" alt="image" src="https://github.com/user-attachments/assets/77f3cb3a-2eb0-41ac-95bf-d02915589690" /> | | <img width="1231" height="650" alt="image copy 2" src="https://github.com/user-attachments/assets/583374af-96e0-4436-b026-4ce79b7f9321" /> | <img width="1252" height="650" alt="image copy" src="https://github.com/user-attachments/assets/aa81fb31-fd18-4e21-a40e-d8ab0dc76b4e" /> | ## Checklist: - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my code - [x] I have commented on my code, particularly in hard-to-understand areas - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [x] Any dependent changes have been merged and published in downstream modules
147 lines
6.0 KiB
Ruby
147 lines
6.0 KiB
Ruby
require 'rails_helper'
|
|
|
|
RSpec.describe 'Webhooks API', type: :request do
|
|
let(:account) { create(:account) }
|
|
let(:inbox) { create(:inbox, account: account) }
|
|
let(:webhook) { create(:webhook, account: account, inbox: inbox, url: 'https://hello.com', name: 'My Webhook') }
|
|
let(:administrator) { create(:user, account: account, role: :administrator) }
|
|
let(:agent) { create(:user, account: account, role: :agent) }
|
|
|
|
describe 'GET /api/v1/accounts/<account_id>/webhooks' do
|
|
context 'when it is an authenticated agent' do
|
|
it 'returns unauthorized' do
|
|
get "/api/v1/accounts/#{account.id}/webhooks",
|
|
headers: agent.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an authenticated admin user' do
|
|
it 'gets all webhook' do
|
|
get "/api/v1/accounts/#{account.id}/webhooks",
|
|
headers: administrator.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:success)
|
|
expect(response.parsed_body['payload']['webhooks'].count).to eql account.webhooks.count
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'POST /api/v1/accounts/<account_id>/webhooks' do
|
|
context 'when it is an authenticated agent' do
|
|
it 'returns unauthorized' do
|
|
post "/api/v1/accounts/#{account.id}/webhooks",
|
|
headers: agent.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an authenticated admin user' do
|
|
it 'creates webhook' do
|
|
post "/api/v1/accounts/#{account.id}/webhooks",
|
|
params: { account_id: account.id, inbox_id: inbox.id, url: 'https://hello.com' },
|
|
headers: administrator.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:success)
|
|
|
|
expect(response.parsed_body['payload']['webhook']['url']).to eql 'https://hello.com'
|
|
end
|
|
|
|
it 'creates webhook with name' do
|
|
post "/api/v1/accounts/#{account.id}/webhooks",
|
|
params: { account_id: account.id, inbox_id: inbox.id, url: 'https://hello.com', name: 'My Webhook' },
|
|
headers: administrator.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:success)
|
|
|
|
expect(response.parsed_body['payload']['webhook']['name']).to eql 'My Webhook'
|
|
end
|
|
|
|
it 'throws error when invalid url provided' do
|
|
post "/api/v1/accounts/#{account.id}/webhooks",
|
|
params: { account_id: account.id, inbox_id: inbox.id, url: 'javascript:alert(1)' },
|
|
headers: administrator.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:unprocessable_entity)
|
|
expect(response.parsed_body['message']).to eql 'Url is invalid'
|
|
end
|
|
|
|
it 'throws error if subscription events are invalid' do
|
|
post "/api/v1/accounts/#{account.id}/webhooks",
|
|
params: { url: 'https://hello.com', subscriptions: ['conversation_random_event'] },
|
|
headers: administrator.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:unprocessable_entity)
|
|
expect(response.parsed_body['message']).to eql 'Subscriptions Invalid events'
|
|
end
|
|
|
|
it 'throws error if subscription events are empty' do
|
|
post "/api/v1/accounts/#{account.id}/webhooks",
|
|
params: { url: 'https://hello.com', subscriptions: [] },
|
|
headers: administrator.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:unprocessable_entity)
|
|
expect(response.parsed_body['message']).to eql 'Subscriptions Invalid events'
|
|
end
|
|
|
|
it 'use default if subscription events are nil' do
|
|
post "/api/v1/accounts/#{account.id}/webhooks",
|
|
params: { url: 'https://hello.com', subscriptions: nil },
|
|
headers: administrator.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:ok)
|
|
expect(
|
|
response.parsed_body['payload']['webhook']['subscriptions']
|
|
).to eql %w[conversation_status_changed conversation_updated conversation_created contact_created contact_updated
|
|
message_created message_updated webwidget_triggered]
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'PUT /api/v1/accounts/<account_id>/webhooks/:id' do
|
|
context 'when it is an authenticated agent' do
|
|
it 'returns unauthorized' do
|
|
put "/api/v1/accounts/#{account.id}/webhooks/#{webhook.id}",
|
|
headers: agent.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an authenticated admin user' do
|
|
it 'updates webhook' do
|
|
put "/api/v1/accounts/#{account.id}/webhooks/#{webhook.id}",
|
|
params: { url: 'https://hello.com', name: 'Another Webhook' },
|
|
headers: administrator.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:success)
|
|
expect(response.parsed_body['payload']['webhook']['url']).to eql 'https://hello.com'
|
|
expect(response.parsed_body['payload']['webhook']['name']).to eql 'Another Webhook'
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'DELETE /api/v1/accounts/<account_id>/webhooks/:id' do
|
|
context 'when it is an authenticated agent' do
|
|
it 'returns unauthorized' do
|
|
delete "/api/v1/accounts/#{account.id}/webhooks/#{webhook.id}",
|
|
headers: agent.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an authenticated admin user' do
|
|
it 'deletes webhook' do
|
|
delete "/api/v1/accounts/#{account.id}/webhooks/#{webhook.id}",
|
|
headers: administrator.create_new_auth_token,
|
|
as: :json
|
|
expect(response).to have_http_status(:success)
|
|
expect(account.webhooks.count).to be 0
|
|
end
|
|
end
|
|
end
|
|
end
|