Files
upstream-mirror 30810eecd7
Some checks failed
Create issues from TODOs / todos (push) Failing after 3s
Close inactive issues / close-issues (push) Has been cancelled
Deploy GitHub Pages / deploy-preview (push) Has been cancelled
CI / ⚙️ Variables Setup (push) Has been cancelled
CI / ⚙️ Test Guard (push) Has been cancelled
CI / 🚀 Notify external services - draft (push) Has been cancelled
CI / 📦 Build Packages (push) Has been cancelled
CI / 📦 Meteor Build (coverage) (push) Has been cancelled
CI / 📦 Meteor Build (production) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [account-service presence-service omnichannel-transcript-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [account-service presence-service omnichannel-transcript-service], fips) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [authorization-service queue-worker-service ddp-streamer-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [authorization-service queue-worker-service ddp-streamer-service], fips) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], coverage) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], fips) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [account-service presence-service omnichannel-transcript-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [authorization-service queue-worker-service ddp-streamer-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [rocketchat], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [rocketchat], coverage) (push) Has been cancelled
CI / 🚢 Publish Docker Images (ghcr.io) (push) Has been cancelled
CI / 📦 Track Image Sizes (push) Has been cancelled
CI / 🔎 Code Check - Action Lint (push) Has been cancelled
CI / 🔎 Code Check (push) Has been cancelled
CI / 🔨 Test Storybook (push) Has been cancelled
CI / 🔨 Test Unit (push) Has been cancelled
CI / 🔨 Test API (CE) (push) Has been cancelled
CI / 🔨 Test API Livechat (CE) (push) Has been cancelled
CI / 🔨 Test UI (CE) (push) Has been cancelled
CI / 🔨 Test API (EE) (push) Has been cancelled
CI / 🔨 Test API Livechat (EE) (push) Has been cancelled
CI / 🔨 Test API Apps (deno-runtime - EE) (push) Has been cancelled
CI / 🔨 Test UI (EE) (push) Has been cancelled
CI / 🔨 Test API (FIPS) (push) Has been cancelled
CI / 🔨 Test API Livechat (FIPS) (push) Has been cancelled
CI / 🔨 Test UI (FIPS) (push) Has been cancelled
CI / 🔨 Test Federation Matrix (push) Has been cancelled
CI / 📊 Report Coverage (push) Has been cancelled
CI / ✅ Tests Done (push) Has been cancelled
CI / 🚀 Publish build assets (push) Has been cancelled
CI / 🚀 Publish Docker Images (DockerHub) (push) Has been cancelled
CI / 🚀 Notify external services (push) Has been cancelled
CI / Update Version Durability (push) Has been cancelled
Release / Release (push) Has been cancelled
Auto-close duplicate issues / auto-close-duplicates (push) Failing after 1s
Code scanning - action / CodeQL-Build (push) Failing after 2s
snapshot of https://github.com/RocketChat/Rocket.Chat.git (develop, 2026-09-16; blobs > 131072B omitted)
2026-09-16 01:21:02 +05:00

240 lines
7.6 KiB
TypeScript

import type { SettingValue } from '@rocket.chat/core-typings';
import type { SelectOption } from '@rocket.chat/fuselage';
import {
Box,
FieldGroup,
Field,
FieldRow,
TextInput,
MultiSelect,
Button,
ButtonGroup,
NumberInput,
FieldLabel,
} from '@rocket.chat/fuselage';
import { useStableCallback } from '@rocket.chat/fuselage-hooks';
import { ExternalLink, Page, PageHeader, PageScrollableContentWithShadow } from '@rocket.chat/ui-client';
import { useToastMessageDispatch, useTranslation, useEndpoint } from '@rocket.chat/ui-contexts';
import { useMutation } from '@tanstack/react-query';
import { useMemo } from 'react';
import { Controller, useForm, useWatch } from 'react-hook-form';
import { links } from '../../../lib/links';
export type WebhooksPageProps = {
settings: Record<string, SettingValue>;
};
type SendOnOptions =
| 'Livechat_webhook_on_start'
| 'Livechat_webhook_on_close'
| 'Livechat_webhook_on_chat_taken'
| 'Livechat_webhook_on_chat_queued'
| 'Livechat_webhook_on_forward'
| 'Livechat_webhook_on_offline_msg'
| 'Livechat_webhook_on_visitor_message'
| 'Livechat_webhook_on_agent_message';
type WebhooksPageFormData = {
Livechat_webhookUrl: string;
Livechat_secret_token: string;
Livechat_http_timeout: string;
sendOn: SendOnOptions[];
};
const reduceSendOptions = (options: Record<string, SettingValue>) =>
Object.entries(options).reduce<string[]>((acc, [key, val]) => {
if (val) {
acc = [...acc, key];
}
return acc;
}, []);
const INTEGRATION_URL = links.webhooks;
const getInitialValues = ({
Livechat_webhookUrl,
Livechat_secret_token,
Livechat_webhook_on_start,
Livechat_webhook_on_close,
Livechat_webhook_on_chat_taken,
Livechat_webhook_on_chat_queued,
Livechat_webhook_on_forward,
Livechat_webhook_on_offline_msg,
Livechat_webhook_on_visitor_message,
Livechat_webhook_on_agent_message,
Livechat_http_timeout,
}: WebhooksPageProps['settings']): WebhooksPageFormData => {
const mappedSendOptions = reduceSendOptions({
Livechat_webhook_on_start,
Livechat_webhook_on_close,
Livechat_webhook_on_chat_taken,
Livechat_webhook_on_chat_queued,
Livechat_webhook_on_forward,
Livechat_webhook_on_offline_msg,
Livechat_webhook_on_visitor_message,
Livechat_webhook_on_agent_message,
});
return {
Livechat_webhookUrl,
Livechat_secret_token,
Livechat_http_timeout,
sendOn: mappedSendOptions,
} as WebhooksPageFormData;
};
const WebhooksPage = ({ settings }: WebhooksPageProps) => {
const t = useTranslation();
const dispatchToastMessage = useToastMessageDispatch();
const defaultValues = getInitialValues(settings);
const {
control,
reset,
formState: { isDirty, isSubmitting },
handleSubmit,
} = useForm({
defaultValues,
});
const save = useEndpoint('POST', '/v1/omnichannel/integrations');
const test = useEndpoint('POST', '/v1/livechat/webhook.test');
const livechatWebhookUrl = useWatch({ name: 'Livechat_webhookUrl', control });
const canTest = !(livechatWebhookUrl && !isDirty);
const sendOptions = useMemo<SelectOption[]>(
() => [
['Livechat_webhook_on_start', t('Chat_start')],
['Livechat_webhook_on_close', t('Chat_close')],
['Livechat_webhook_on_chat_taken', t('Chat_taken')],
['Livechat_webhook_on_chat_queued', t('Chat_queued')],
['Livechat_webhook_on_forward', t('Forwarding')],
['Livechat_webhook_on_offline_msg', t('Offline_messages')],
['Livechat_webhook_on_visitor_message', t('Visitor_message')],
['Livechat_webhook_on_agent_message', t('Agent_messages')],
],
[t],
);
const handleSave = useStableCallback(async (values: WebhooksPageFormData) => {
const { sendOn, Livechat_webhookUrl, Livechat_secret_token, Livechat_http_timeout } = values;
try {
await save({
LivechatWebhookUrl: Livechat_webhookUrl,
LivechatSecretToken: Livechat_secret_token,
LivechatHttpTimeout: parseInt(Livechat_http_timeout, 10),
LivechatWebhookOnStart: sendOn.includes('Livechat_webhook_on_start'),
LivechatWebhookOnClose: sendOn.includes('Livechat_webhook_on_close'),
LivechatWebhookOnChatTaken: sendOn.includes('Livechat_webhook_on_chat_taken'),
LivechatWebhookOnChatQueued: sendOn.includes('Livechat_webhook_on_chat_queued'),
LivechatWebhookOnForward: sendOn.includes('Livechat_webhook_on_forward'),
LivechatWebhookOnOfflineMsg: sendOn.includes('Livechat_webhook_on_offline_msg'),
LivechatWebhookOnVisitorMessage: sendOn.includes('Livechat_webhook_on_visitor_message'),
LivechatWebhookOnAgentMessage: sendOn.includes('Livechat_webhook_on_agent_message'),
});
reset(values);
dispatchToastMessage({ type: 'success', message: t('Saved') });
} catch (error) {
dispatchToastMessage({ type: 'error', message: error });
}
});
const testWebhook = useMutation({
mutationFn: () => test(),
onSuccess: () => dispatchToastMessage({ type: 'success', message: t('It_works') }),
onError: (error) => dispatchToastMessage({ type: 'error', message: error }),
});
return (
<Page>
<PageHeader title={t('Webhooks')}>
<ButtonGroup>
<Button onClick={() => reset()} disabled={!isDirty || isSubmitting}>
{t('Reset')}
</Button>
<Button
onClick={() => testWebhook.mutateAsync()}
disabled={canTest || testWebhook.isPending}
title={canTest ? t('Webhook_URL_not_set') : ''}
>
{testWebhook.isPending ? t('Sending') : t('Send_Test')}
</Button>
<Button primary onClick={handleSubmit(handleSave)} loading={isSubmitting} disabled={!isDirty}>
{t('Save')}
</Button>
</ButtonGroup>
</PageHeader>
<PageScrollableContentWithShadow>
<Box maxWidth='x600' width='full' alignSelf='center'>
<p>{t('You_can_use_webhooks_to_easily_integrate_livechat_with_your_CRM')}</p>
<p>
<ExternalLink to={INTEGRATION_URL}>{t('Click_here')}</ExternalLink> {t('to_see_more_details_on_how_to_integrate')}
</p>
<FieldGroup style={{ marginTop: '1.5rem' }}>
<Field>
<FieldLabel>{t('Webhook_URL')}</FieldLabel>
<FieldRow>
<Controller
control={control}
name='Livechat_webhookUrl'
render={({ field: { onChange, value } }) => (
<TextInput onChange={onChange} value={value} placeholder='https://yourdomain.com/webhook/entrypoint' />
)}
/>
</FieldRow>
</Field>
<Field>
<FieldLabel>{t('Secret_token')}</FieldLabel>
<FieldRow>
<Controller
control={control}
name='Livechat_secret_token'
render={({ field: { onChange, value } }) => (
<TextInput onChange={onChange} value={value} placeholder={t('Secret_token')} />
)}
/>
</FieldRow>
</Field>
<Field>
<FieldLabel>{t('Send_request_on')}</FieldLabel>
<FieldRow>
<Box width='full' display='flex' alignItems='stretch' justifyContent='stretch'>
<Controller
control={control}
name='sendOn'
render={({ field: { onChange, value } }) => (
<MultiSelect
width='full'
value={value}
onChange={onChange}
options={sendOptions}
placeholder={t('Select_an_option')}
/>
)}
/>
</Box>
</FieldRow>
</Field>
<Field>
<FieldLabel>{t('Http_timeout')}</FieldLabel>
<FieldRow>
<Controller
control={control}
name='Livechat_http_timeout'
render={({ field: { onChange, value } }) => (
<NumberInput onChange={onChange} value={value} placeholder={t('Http_timeout_value')} />
)}
/>
</FieldRow>
</Field>
</FieldGroup>
</Box>
</PageScrollableContentWithShadow>
</Page>
);
};
export default WebhooksPage;