Анализ проблем с вебхуками

Анализ свойств вебхуков

В разделе «Управление конфигурацией» появился новый тип элементов — «Вебхук». Если открыть запись вебхука через пакет, вы перейдете на страницу с настройками, как и при переходе через «Дизайнер системы».

В контекстном меню записи есть пункт «Открыть метаданные». При его выборе вы увидите текстовое представление данных из поля MetaData объекта VwWebhookV2. На вкладке «Метаданные» данные будут отображаться в необработанном виде, а на вкладке «Метаданные (чтение)» — в более удобной для чтения форме. Это позволяет сопоставлять названия блоков в JSON-строке с их значениями.

    A2: Name;
    A5: CreatedInPackageId;
    B1: Methods;
    B2: LocalizableStrings;
    B3: Usings;
    B6: PackageUId;
    B8: CreatedInVersion;
    WS1: CheckClientUrl (если признак Проверять URL клиента не заполнен, блок отсутствует);
    WS2: ClientUrl;
    WS3: WebhookAuthInfo (при указании типа аутентификации Не требуется блок отсутствует полностью);
        WS3.IY1: AuthType (1 — Cookie, 2 — JWT);
        WS3.IZ1: Username;
            WS3.IZ1.IV2: Source;
        WS3.IZ2: Password;
            WS3.IZ2.IV2: Source;
        WS3.IZ3: UserId;
            WS3.IZ3.IV1: Value;
            WS3.IZ3.IV2: Source;
        WS3.IZ4: ValidBefore;
            WS3.IZ4.IV2: Source;
        WS3.JD1: UserId;
            WS3.JD1.IV1: Value;
            WS3.JD1.IV2: Source;
        WS3.JD2: Token;
            WS3.JD2.IV2: Source;
        WS3.JD3: TokenHeader;
            WS3.JD3.IV1: Value;
            WS3.JD3.IV2: Source;
        WS3.JD4: ValidBefore;
            WS3.JD4.IV1: Value;
            WS3.JD4.IV2: Source;
    WS4: WebhookMethods;
        WS4.A2: Name;
        WS4.A3: CreatedInSchemaUId;
        WS4.A4: ModifiedInSchemaUId;
        WS4.IR1: Request;
            WS4.IR1.IW1: Parameters;
        WS4.IR2: Response;
            WS4.IR2.IW1: Parameters;
        WS4.IR4: Endpoint;
        WS4.IR5: HttpMethodType (1 — GET, 2 — POST);
        WS4.IR6: WebhookContentType;
        WS4.IR8: ActionRules;
            WS4.IR8.A2: Name;
            WS4.IR8.AR1: ActionRuleType (1 — запуск БП, 3 — изменить данные, 4 — добавить данные);
            WS4.IR8.AR2: ProcessedObjectId;
            WS4.IR8.AR3: MethodInputParamByBpInputParams;
            WS4.IR8.AR4: MethodOutputParamByBpOutputParams;
            WS4.IR8.AR5: MethodInputParamByObjectParams;
            WS4.IR8.AR6: MethodInputParamByObjectFilterParams;
            WS4.IR8.AR7: MethodOutputParamByObjectOutputParams;
        WS4.IR9: IsPublished.

Основные сведения о вебхуках можно получить, выполнив запрос в базе данных:

select * from VwWebhookV2;

select * from "VwWebhookV2";

Информация о структуре вебхуков и результаты SQL запроса к VwWebhookV2 полезна для первичной диагностики проблем с вебхуками. С их помощью можно:

• Проверить корректность заполнения ключевых полей (ClientUrl, AuthType, HttpMethodType и др.);
• Убедиться, что все обязательные блоки JSON присутствуют с учетом условий (например, отсутствие блока WS3: WebhookAuthInfo при типе аутентификации «Не требуется»);
• Сопоставить настройки вебхука с его поведением (например, соответствие HttpMethodType).

Если самостоятельная диагностика не позволила устранить проблему, пожалуйста, соберите следующую информацию и обратитесь в техническую поддержку BPMSoft:

1. Результат SQL‑запроса к VwWebhookV2 (или его релевантную часть).
2. Скопированные метаданные вебхука (вкладки «Метаданные» и «Метаданные (чтение)»).
3. Выявленные несоответствия в метаданных (например: «Поле HttpMethodType = 2 (POST), но эндпоинт поддерживает только GET»).
4. Краткое и точное описание возникшей проблемы.

Анализ ошибок вебхуков

С версии BPMSoft 1.9 вебхуки отображают более детализированные тексты ошибок. Ниже приведены сценарии, при которых могут появляться такие сообщения.

Таблица 1 — Детализация ошибок вебхуков

Не работает анонимная аутентификация

Проблема

Вызовы методов вебхука с анонимной аутентификацией не работают. Вместо этого происходит перенаправление на страницу авторизации.

Решение

1. Проверьте, что в параметре AllowedLocations конфигурационного файла (для .NET Framework – во «внутреннем» Web.config) присутствует значение webhook/*.

<add key="AllowedLocations" value="api/HealthCheck/Ping;ServiceModel/MsgUtilService.svc; …; webhook/*" />

При отсутствии значения необходимо его добавить внутри value в конец строки и перезапустить приложение BPMSoft.

2. Если используется BPMSoft на платформе .NET Framework, то проверьте, что во «внутреннем» Web.config присутствует блок настроек:

<location path="webhook">
      <system.web>
        <authorization>
          <allow users="*" />
        </authorization>
      </system.web>
</location>

При отсутствии блока добавьте его в конфигурационный файл, например, между блоками <location path="ServiceModel/TotpResetPasswordService.svc">…</location> и <location path="Nui/Feedback.aspx">…</location>.

Рекомендуем изучить

Настройка интеграции вебхуков
Общие принципы диагностики проблем интеграций и инфраструктуры