Web Kancaları

Yöneticiler, kişilerin belirli bir URL'ye bildirimler gönderebilmeleri için web kancaları kurabilirler. Bu, bir sorunun sonuçlarını seçtiğiniz bir uç noktaya göndermek için bir bildirim ayarlayabileceğiniz anlamına gelir: uygulamanıza, üçüncü taraf bir hizmete veya başka bir yere.

Şu anda, web kancaları yalnızca bildirimler için kullanılabilir; bir gösterge tablosu aboneliği alıcısı olarak bir web kancası seçemezsiniz.

Bir web kancası oluşturma

Bir bildirimi bir web kancasına göndermeden önce, bir yönetici hedeflemek için bir web kancası oluşturmalıdır.

Yöneticiler, dişli simgesi > Yönetici ayarları > Bildirim kanalları'na tıklayarak bir web kancası oluşturabilirler. bildirimler için Web Kancaları bölümünde, + Başka bir tane ekle'ye tıklayın. Patrona size doldurmanız için kısa bir form verecektir:

• Webhook URL'si. Patrona'nın bir bildirimin sonuçlarını göndermesini istediğiniz yer. Geçerli bir URL olmalıdır.
• Ad verin. Web kancasını adlandırmanız gerekir, böylece kişiler bir soruya bildirim ayarlarken doğru kancayı seçebilirler.
• Açıklama. Kişilere kancanın ne için olduğunu söylemelisiniz.
• Kimlik doğrulama yöntemi. Aşağıya bakın.

Web kancası kimlik doğrulama yöntemi

Web kancası için bir kimlik doğrulama yöntemi belirleyebilirsiniz.

• Hiçbiri: Her şey kabul edilir.
• Temel: Bir kullanıcı adı ve şifre ayarlayın.
• Taşıyıcı: Bir gizli jeton ekleyin.
• API anahtarı: API anahtarını Başlığa veya Sorgu parametresi olarak ekleyebilirsiniz. Her iki yaklaşım da bir anahtar ve değer (API anahtarının kendisi) gerektirir.

Web kancası yükü

Patrona, bir bildirimin sonuçlarını JSON formatında gönderecektir. JSON, bildirimin yaratıcısı ve kimliği (test bildirimleri durumunda null) gibi soruyla ilgili bazı meta verileri içerecektir.

Patrona, "ekli" görselleştirmeyi visualization altında data anahtarında base64 kodlu bir PNG olarak gönderecektir.

Ve tablo görünümünde görülen veriler, Patrona tarafından raw_data olarak gönderilecektir.

Bir bildirim için örnek bir yük burada (PNG kodlamasını uzun ve son derece sıkıcı olduğu için kestik):

{
  "type": "alert",
  "alert_id": null,
  "alert_creator_id": 2666,
  "alert_creator_name": "Roberto Bolaño",
  "data": {
    "type": "question",
    "question_id": 108,
    "question_name": "Sales",
    "question_url": "http://example.com/question/108",
    "visualization": "data:image/png;base64,=...LONG_ENCODED_PNG_HERE...",
    "raw_data": {
      "cols": [
        "CREATED_AT",
        "count"
      ],
      "rows": [
        [
          "2023-09-01T00:00:00Z",
          346
        ],
        [
          "2023-10-01T00:00:00Z",
          354
        ],
        [
          "2023-11-01T00:00:00Z",
          394
        ],
        [
          "2023-12-01T00:00:00Z",
          418
        ],
        [
          "2024-01-01T00:00:00Z",
          457
        ],
        [
          "2024-02-01T00:00:00Z",
          404
        ],
        [
          "2024-03-01T00:00:00Z",
          445
        ],
        [
          "2024-04-01T00:00:00Z",
          439
        ],
        [
          "2024-05-01T00:00:00Z",
          520
        ],
        [
          "2024-06-01T00:00:00Z",
          455
        ],
        [
          "2024-07-01T00:00:00Z",
          523
        ],
        [
          "2024-08-01T00:00:00Z",
          501
        ]
      ]
    }
  },
  "sent_at": "2024-09-30T20:16:15.76582Z"
}

Daha fazla okuma

• bildirimler