Управление вебхуками

Как администратор, вы можете обновлять вебхуки организации и управлять ими, обновляя их конфигурацию (например, обновляя триггеры событий, на которые подписан webhook), а также отключая и удаляя настроенные ранее вебхуки.

Обновление вебхуков

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

Обновление вебхуков организации

Чтобы обновить вебхук организации через веб-сайт портала ArcGIS Enterprise, выполните следующие шаги:

  1. Убедитесь, что вы вошли как администратор по умолчанию или участник с пользовательской ролью, имеющей права администратора для создания и управления вебхуками организации.
  2. Перейдите к Организация > Настройки > Вебхуки.
  3. В разделе Вебхуки организации найдите вебхук, который хотите обновить.
  4. Щелкните кнопку Опции и выберите Редактировать.
  5. В окне Редактировать вебхук измените следующее:
    1. Для обновления имени вебхука предоставьте уникальное имя для вебхука в текстовом поле Имя.
    2. Чтобы обновить тип вебхука, щелкните ниспадающее меню Тип и выберите новый тип вебхука.
      • При выборе Все вы будете подписаны на все поддерживаемые триггеры событий. Вы будете получать уведомления о каждом событии, как только оно произойдет.
      • Выбор Элементы, Пользователи, Группы или Роли позволяет вам вручную определить, на какие триггерные события вы хотите подписаться.
    3. Если вы выберете тип вебхук, отличный от Все, появится дополнительное ниспадающее меню, зависящее от выбранного типа вебхука. Например, если вы выбрали Элементы в качестве типа вебхука, появится ниспадающее меню Элементы, где можно выбрать определенный элемент, который вебхук будет отслеживать.
    4. Чтобы обновить триггеры события, щелкните ниспадающее меню События и выберите новое событие триггера. Например, если вы хотите, чтобы вебхук вызывался при публикации определенного элемента, выберите /items/<Item ID>/publish.
    5. Если вам нужно обновить URL-адрес полезных данных, выберите URL-адрес вебхука и укажите новый URL-адрес полезных данных для приемника вебхука.
    6. Можете также добавить буквенно-цифровую строку, которая служит секретным ключом для вебхука,, или обновите существовавший секретный ключ в текстовом поле Секретный ключ (по желанию). Это секретное значение будет использоваться для создания подписи, которая будет включена в заголовки полезной нагрузки вебхука. Получатель вебхука может использовать эту подпись, чтобы определить, следует ли доверять сообщению.
  6. Щелкните Обновить вебхук, чтобы применить внесенные изменения.

Обновление вебхуков сервиса

Для обновления свойств вебхука сервиса выполните следующие шаги:

  1. Убедитесь, что вы вошли как администратор по умолчанию или участник с пользовательской ролью, имеющей права администратора для создания и управления вебхуками сервиса.

    Примечание:
    Участники, которым назначена роль издателя (publisher), не смогут создавать вебхуки сервиса или управлять ими с сайта портала ArcGIS Enterprise, и им необходимо будет выполнять эти с использованием административного API.

  2. Перейдите к Организация > Настройки > Вебхуки.
  3. В Вебхуки сервиса найдите вебхук, который хотите обновить.
  4. Щелкните кнопку Опции и выберите Редактировать.
  5. В окне Редактировать вебхук измените следующее:
    1. Для обновления имени вебхука предоставьте уникальное имя для вебхука в текстовом поле Имя.
    2. Чтобы обновить сервис, с которым связан вебхук, щелкните ниспадающее меню Сервис и выберите новый сервис.

      Примечание:

      При выборе сервиса геообработки событие будет установлено как Сервис завершен. При выборе сервиса объектов будет открыто ниспадающее меню События.

    3. Если вы выбрали вебхук сервиса объектов, выберите новые триггеры событий в ниспадающем меню События. Например, если вы хотите, чтобы вебхук вызывался при обновлении вложения объекта, выберите AttachmentsUpdated.
    4. Если вам нужно обновить URL-адрес полезных данных, выберите URL-адрес вебхука и укажите новый URL-адрес полезных данных для приемника вебхука.
    5. Можете также добавить буквенно-цифровую строку, которая служит секретным ключом для вебхука,, или обновите ранее существовавший секретный ключ в текстовом поле Секретный ключ (по желанию). Секретное значение будет использоваться для создания подписи, которая будет включена в заголовки полезной нагрузки вебхука. Получатель вебхука может использовать эту подпись, чтобы определить, следует ли доверять сообщению.
  6. Щелкните Обновить вебхук, чтобы применить внесенные изменения.

Деактивация вебхуков

Вебхуки можно деактивированы вручную или после выполнения условия деактивации. Когда вебхук деактивирован, он приостанавливается и не может доставлять полезные данные при их запуске. В следующих разделах описано, как отключить вебхуки организации и вебхуки сервисов.

Деактивация вебхуков организации

Чтобы деактивировать вебхук организации через веб-сайт портала ArcGIS Enterprise, выполните следующие шаги:

  1. Убедитесь, что вы вошли как администратор по умолчанию или участник с пользовательской ролью, имеющей права администратора для создания и управления вебхуками организации.
  2. Перейдите к Организация > Настройки > Вебхуки.
  3. В разделе Вебхуки организации найдите вебхук организации, который хотите деактивировать и щелкните Активный.
  4. Щелкните Подтвердить, чтобы приостановить вебхук.

Деактивация вебхуков сервисов

Чтобы деактивировать вебхук сервиса, выполните следующее:

  1. Убедитесь, что вы вошли как администратор по умолчанию или участник с пользовательской ролью, имеющей права администратора для создания и управления вебхуками сервиса.

    Примечание:
    Участники, которым назначена роль издателя (publisher), не смогут создавать вебхуки сервиса или управлять ими с сайта портала ArcGIS Enterprise, и им необходимо будет выполнять эти с использованием административного API.

  2. Перейдите к Организация > Настройки > Вебхуки.
  3. В разделе Вебхуки сервиса найдите вебхук сервиса, который хотите деактивировать и щелкните Активный.
  4. Щелкните Подтвердить, чтобы приостановить вебхук.

Активация вебхуков

Пока вебхук деактивирован, он не будет иметь возможность доставлять полезные данные. Повторная активация вебхука перезапускает вебхук и включает его возможность доставлять полезные данные при следующем вызове вебхукаю В следующих разделах описывается, как активировать деактивированные ранее вебхуки организации и вебхуки сервисов.

Активация вебхуков организации

Чтобы активировать вебхук организации через веб-сайт портала ArcGIS Enterprise, выполните следующие шаги:

  1. Убедитесь, что вы вошли как администратор по умолчанию или участник с пользовательской ролью, имеющей права администратора для создания и управления вебхуками организации.
  2. Перейдите к Организация > Настройки > Вебхуки.
  3. В разделе Вебхуки организации найдите вебхук организации, который хотите активировать и щелкните Неактивный.
  4. Нажмите Подтвердить, чтобы перезапустить вебхук.

Активация вебхуков сервисов

Чтобы активировать вебхук сервиса, выполните следующее:

  1. Убедитесь, что вы вошли как администратор по умолчанию или участник с пользовательской ролью, имеющей права администратора для создания и управления вебхуками сервиса.

    Примечание:
    Участники, которым назначена роль издателя (publisher), не смогут создавать вебхуки сервиса или управлять ими с сайта портала ArcGIS Enterprise, и им необходимо будет выполнять эти с использованием административного API.

  2. Перейдите к Организация > Настройки > Вебхуки.
  3. В разделе Вебхуки сервиса найдите вебхук сервиса, который хотите активировать и щелкните Неактивный.
  4. Нажмите Подтвердить, чтобы перезапустить вебхук.

Удаление вебхуков

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

Удаление вебхуков организации

Чтобы обновить вебхук организации через веб-сайт портала ArcGIS Enterprise, выполните следующие шаги:

  1. Убедитесь, что вы вошли как администратор по умолчанию или участник с пользовательской ролью, имеющей права администратора для создания и управления вебхуками организации.
  2. Перейдите к Организация > Настройки > Вебхуки.
  3. В разделе Вебхуки организации найдите вебхук организации, который хотите обновить.
  4. Щелкните кнопку Опции и затем Удалить.
  5. В окне Удалить нажмите кнопку Подтвердить, чтобы окончательно удалить вебхук.

Удаление вебхуков сервисов

Чтобы удалить вебхук сервиса, выполните следующее:

  1. Убедитесь, что вы вошли как администратор по умолчанию или участник с пользовательской ролью, имеющей права администратора для создания и управления вебхуками сервиса.

    Примечание:
    Участники, которым назначена роль издателя (publisher), не смогут создавать вебхуки сервиса или управлять ими с сайта портала ArcGIS Enterprise, и им необходимо будет выполнять эти с использованием административного API.

  2. Перейдите к Организация > Настройки > Вебхуки.
  3. В разделе Вебхуки сервиса найдите вебхук сервиса, который хотите обновить.
  4. Щелкните кнопку Опции и затем Удалить.
  5. В окне Удалить нажмите кнопку Подтвердить, чтобы окончательно удалить вебхук.