Gemini Webhooks API

Webhook memungkinkan Gemini API mengirimkan notifikasi real-time ke server Anda saat Operasi Asinkron atau Operasi yang Berjalan Lama (LRO) selesai. Hal ini menggantikan kebutuhan untuk melakukan polling API guna mendapatkan info terbaru status, sehingga mengurangi latensi dan overhead.

Lihat sebagai markdown Melihat Spesifikasi OpenAPI

CreateWebhook

post https://generativelanguage.googleapis.com/v1beta/webhooks

Membuat Webhook baru.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

name string  (opsional)

Opsional. Nama webhook yang diberikan pengguna.

subscribed_events array (enum (string))  (wajib)

Wajib. Peristiwa yang menjadi langganan webhook. Peristiwa yang tersedia: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Nilai yang mungkin:

  • batch.succeeded

    Batch processing berhasil diselesaikan.

  • batch.expired

    Batch belum diproses dalam jangka waktu 48 jam.

  • batch.failed

    Tugas batch gagal.

  • interaction.requires_action

    Interaksi memerlukan tindakan (misalnya, panggilan fungsi).

  • interaction.completed

    Interaksi berhasil diselesaikan.

  • interaction.failed

    Interaksi gagal.

  • video.generated

    Pembuatan video selesai.

uri string  (wajib)

Wajib. URI yang menjadi tujuan pengiriman peristiwa webhook.

Respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

create_time string  (opsional)

Hanya output. Stempel waktu saat webhook dibuat.

id string  (opsional)

Hanya output. ID webhook.

name string  (opsional)

Opsional. Nama webhook yang diberikan pengguna.

new_signing_secret string  (opsional)

Hanya output. Rahasia penandatanganan baru untuk webhook. Hanya diisi saat pembuatan.

signing_secrets array (SigningSecret)  (opsional)

Hanya output. Rahasia penandatanganan yang terkait dengan webhook ini.

Mewakili secret penandatanganan yang digunakan untuk memverifikasi payload webhook.

Kolom

expire_time string  (opsional)

Hanya output. Tanggal habis masa berlaku secret penandatanganan.

truncated_secret string  (opsional)

Hanya output. Versi singkat dari secret penandatanganan.

state enum (string)  (opsional)

Hanya output. Status webhook.

Nilai yang mungkin:

  • enabled

    Webhook diaktifkan.

  • disabled

    Webhook dinonaktifkan oleh pengguna.

  • disabled_due_to_failed_deliveries

    Webhook dinonaktifkan karena pengiriman gagal.

subscribed_events array (enum (string))  (opsional)

Wajib. Peristiwa yang menjadi langganan webhook. Peristiwa yang tersedia: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Nilai yang mungkin:

  • batch.succeeded

    Batch processing berhasil diselesaikan.

  • batch.expired

    Batch belum diproses dalam jangka waktu 48 jam.

  • batch.failed

    Tugas batch gagal.

  • interaction.requires_action

    Interaksi memerlukan tindakan (misalnya, panggilan fungsi).

  • interaction.completed

    Interaksi berhasil diselesaikan.

  • interaction.failed

    Interaksi gagal.

  • video.generated

    Pembuatan video selesai.

update_time string  (opsional)

Hanya output. Stempel waktu saat webhook terakhir diperbarui.

uri string  (opsional)

Wajib. URI yang menjadi tujuan pengiriman peristiwa webhook.

Contoh

Contoh Respons

{
  "create_time": "string",
  "id": "string",
  "name": "string",
  "new_signing_secret": "string",
  "signing_secrets": [
    {
      "expire_time": "string",
      "truncated_secret": "string"
    }
  ],
  "state": "enabled",
  "subscribed_events": [
    "batch.succeeded"
  ],
  "update_time": "string",
  "uri": "string"
}

PingWebhook

post https://generativelanguage.googleapis.com/v1beta/webhooks/{id}:ping

Mengirim peristiwa ping ke Webhook.

Parameter Jalur / Kueri

id string  (wajib)

Wajib. ID webhook yang akan diping. Format: `{webhook_id}`

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Respons

Jika berhasil, respons akan kosong.

Contoh

RotateSigningSecret

post https://generativelanguage.googleapis.com/v1beta/webhooks/{id}:rotateSigningSecret

Membuat rahasia penandatanganan baru untuk Webhook.

Parameter Jalur / Kueri

id string  (wajib)

Wajib. ID webhook yang akan dibuatkan secret penandatanganan. Format: `{webhook_id}`

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

revocation_behavior enum (string)  (opsional)

Opsional. Perilaku pencabutan untuk secret penandatanganan sebelumnya.

Nilai yang mungkin:

  • revoke_previous_secrets_after_h24

    Buat secret penandatanganan baru dan batalkan semua secret sebelumnya setelah 24 jam. Opsi default dan paling aman untuk migrasi.

  • revoke_previous_secrets_immediately

    Segera batalkan semua rahasia sebelumnya. Gunakan dengan hati-hati karena tindakan ini dapat mengganggu notifikasi yang sedang berlangsung.

Respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

secret string  (opsional)

Hanya output. Secret penandatanganan yang baru dibuat.

Contoh

Contoh Respons

{
  "secret": "string"
}

ListWebhooks

get https://generativelanguage.googleapis.com/v1beta/webhooks

Mencantumkan semua Webhook.

Parameter Jalur / Kueri

page_size integer  (opsional)

Opsional. Jumlah maksimum webhook yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini. Jika tidak ditentukan, paling banyak 50 webhook akan ditampilkan. Nilai maksimumnya adalah 1.000.

page_token string  (opsional)

Opsional. Token halaman, yang diterima dari panggilan `ListWebhooks` sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.

Respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

next_page_token string  (opsional)

Token yang dapat dikirim sebagai `page_token` untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

webhook array (Webhook)  (opsional)

Webhook.

Contoh

Contoh Respons

{
  "next_page_token": "string",
  "webhooks": [
    {
      "create_time": "string",
      "id": "string",
      "name": "string",
      "new_signing_secret": "string",
      "signing_secrets": [
        {
          "expire_time": "string",
          "truncated_secret": "string"
        }
      ],
      "state": "enabled",
      "subscribed_events": [
        "batch.succeeded"
      ],
      "update_time": "string",
      "uri": "string"
    }
  ]
}

GetWebhook

get https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

Mendapatkan Webhook tertentu.

Parameter Jalur / Kueri

id string  (wajib)

Wajib. ID webhook yang akan diambil.

Respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

create_time string  (opsional)

Hanya output. Stempel waktu saat webhook dibuat.

id string  (opsional)

Hanya output. ID webhook.

name string  (opsional)

Opsional. Nama webhook yang diberikan pengguna.

new_signing_secret string  (opsional)

Hanya output. Rahasia penandatanganan baru untuk webhook. Hanya diisi saat pembuatan.

signing_secrets array (SigningSecret)  (opsional)

Hanya output. Rahasia penandatanganan yang terkait dengan webhook ini.

Mewakili secret penandatanganan yang digunakan untuk memverifikasi payload webhook.

Kolom

expire_time string  (opsional)

Hanya output. Tanggal habis masa berlaku secret penandatanganan.

truncated_secret string  (opsional)

Hanya output. Versi singkat dari secret penandatanganan.

state enum (string)  (opsional)

Hanya output. Status webhook.

Nilai yang mungkin:

  • enabled

    Webhook diaktifkan.

  • disabled

    Webhook dinonaktifkan oleh pengguna.

  • disabled_due_to_failed_deliveries

    Webhook dinonaktifkan karena pengiriman gagal.

subscribed_events array (enum (string))  (opsional)

Wajib. Peristiwa yang menjadi langganan webhook. Peristiwa yang tersedia: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Nilai yang mungkin:

  • batch.succeeded

    Batch processing berhasil diselesaikan.

  • batch.expired

    Batch belum diproses dalam jangka waktu 48 jam.

  • batch.failed

    Tugas batch gagal.

  • interaction.requires_action

    Interaksi memerlukan tindakan (misalnya, panggilan fungsi).

  • interaction.completed

    Interaksi berhasil diselesaikan.

  • interaction.failed

    Interaksi gagal.

  • video.generated

    Pembuatan video selesai.

update_time string  (opsional)

Hanya output. Stempel waktu saat webhook terakhir diperbarui.

uri string  (opsional)

Wajib. URI yang menjadi tujuan pengiriman peristiwa webhook.

Contoh

Contoh Respons

{
  "create_time": "string",
  "id": "string",
  "name": "string",
  "new_signing_secret": "string",
  "signing_secrets": [
    {
      "expire_time": "string",
      "truncated_secret": "string"
    }
  ],
  "state": "enabled",
  "subscribed_events": [
    "batch.succeeded"
  ],
  "update_time": "string",
  "uri": "string"
}

UpdateWebhook

patch https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

Memperbarui Webhook yang ada.

Parameter Jalur / Kueri

id string  (wajib)

Wajib. ID webhook yang akan diperbarui.

update_mask string  (opsional)

Opsional. Daftar kolom yang akan diperbarui.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

name string  (opsional)

Opsional. Nama webhook yang diberikan pengguna.

state enum (string)  (opsional)

Opsional. Status webhook.

Nilai yang mungkin:

  • enabled

    Webhook diaktifkan.

  • disabled

    Webhook dinonaktifkan oleh pengguna.

  • disabled_due_to_failed_deliveries

    Webhook dinonaktifkan karena pengiriman gagal.

subscribed_events array (enum (string))  (opsional)

Opsional. Peristiwa yang menjadi langganan webhook. Peristiwa yang tersedia: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Nilai yang mungkin:

  • batch.succeeded

    Batch processing berhasil diselesaikan.

  • batch.expired

    Batch belum diproses dalam jangka waktu 48 jam.

  • batch.failed

    Tugas batch gagal.

  • interaction.requires_action

    Interaksi memerlukan tindakan (misalnya, panggilan fungsi).

  • interaction.completed

    Interaksi berhasil diselesaikan.

  • interaction.failed

    Interaksi gagal.

  • video.generated

    Pembuatan video selesai.

uri string  (opsional)

Opsional. URI yang menjadi tujuan pengiriman peristiwa webhook.

Respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

create_time string  (opsional)

Hanya output. Stempel waktu saat webhook dibuat.

id string  (opsional)

Hanya output. ID webhook.

name string  (opsional)

Opsional. Nama webhook yang diberikan pengguna.

new_signing_secret string  (opsional)

Hanya output. Rahasia penandatanganan baru untuk webhook. Hanya diisi saat pembuatan.

signing_secrets array (SigningSecret)  (opsional)

Hanya output. Rahasia penandatanganan yang terkait dengan webhook ini.

Mewakili secret penandatanganan yang digunakan untuk memverifikasi payload webhook.

Kolom

expire_time string  (opsional)

Hanya output. Tanggal habis masa berlaku secret penandatanganan.

truncated_secret string  (opsional)

Hanya output. Versi singkat dari secret penandatanganan.

state enum (string)  (opsional)

Hanya output. Status webhook.

Nilai yang mungkin:

  • enabled

    Webhook diaktifkan.

  • disabled

    Webhook dinonaktifkan oleh pengguna.

  • disabled_due_to_failed_deliveries

    Webhook dinonaktifkan karena pengiriman gagal.

subscribed_events array (enum (string))  (opsional)

Wajib. Peristiwa yang menjadi langganan webhook. Peristiwa yang tersedia: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Nilai yang mungkin:

  • batch.succeeded

    Batch processing berhasil diselesaikan.

  • batch.expired

    Batch belum diproses dalam jangka waktu 48 jam.

  • batch.failed

    Tugas batch gagal.

  • interaction.requires_action

    Interaksi memerlukan tindakan (misalnya, panggilan fungsi).

  • interaction.completed

    Interaksi berhasil diselesaikan.

  • interaction.failed

    Interaksi gagal.

  • video.generated

    Pembuatan video selesai.

update_time string  (opsional)

Hanya output. Stempel waktu saat webhook terakhir diperbarui.

uri string  (opsional)

Wajib. URI yang menjadi tujuan pengiriman peristiwa webhook.

Contoh

Contoh Respons

{
  "create_time": "string",
  "id": "string",
  "name": "string",
  "new_signing_secret": "string",
  "signing_secrets": [
    {
      "expire_time": "string",
      "truncated_secret": "string"
    }
  ],
  "state": "enabled",
  "subscribed_events": [
    "batch.succeeded"
  ],
  "update_time": "string",
  "uri": "string"
}

DeleteWebhook

delete https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

Menghapus Webhook.

Parameter Jalur / Kueri

id string  (wajib)

Wajib. ID webhook yang akan dihapus. Format: `{webhook_id}`

Respons

Jika berhasil, respons akan kosong.

Contoh

Resource

Webhook

Resource Webhook.

Kolom

create_time string  (opsional)

Hanya output. Stempel waktu saat webhook dibuat.

id string  (opsional)

Hanya output. ID webhook.

name string  (opsional)

Opsional. Nama webhook yang diberikan pengguna.

new_signing_secret string  (opsional)

Hanya output. Rahasia penandatanganan baru untuk webhook. Hanya diisi saat pembuatan.

signing_secrets array (SigningSecret)  (opsional)

Hanya output. Rahasia penandatanganan yang terkait dengan webhook ini.

Mewakili secret penandatanganan yang digunakan untuk memverifikasi payload webhook.

Kolom

expire_time string  (opsional)

Hanya output. Tanggal habis masa berlaku secret penandatanganan.

truncated_secret string  (opsional)

Hanya output. Versi singkat dari secret penandatanganan.

state enum (string)  (opsional)

Hanya output. Status webhook.

Nilai yang mungkin:

  • enabled

    Webhook diaktifkan.

  • disabled

    Webhook dinonaktifkan oleh pengguna.

  • disabled_due_to_failed_deliveries

    Webhook dinonaktifkan karena pengiriman gagal.

subscribed_events array (enum (string))  (opsional)

Wajib. Peristiwa yang menjadi langganan webhook. Peristiwa yang tersedia: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Nilai yang mungkin:

  • batch.succeeded

    Batch processing berhasil diselesaikan.

  • batch.expired

    Batch belum diproses dalam jangka waktu 48 jam.

  • batch.failed

    Tugas batch gagal.

  • interaction.requires_action

    Interaksi memerlukan tindakan (misalnya, panggilan fungsi).

  • interaction.completed

    Interaksi berhasil diselesaikan.

  • interaction.failed

    Interaksi gagal.

  • video.generated

    Pembuatan video selesai.

update_time string  (opsional)

Hanya output. Stempel waktu saat webhook terakhir diperbarui.

uri string  (opsional)

Wajib. URI yang menjadi tujuan pengiriman peristiwa webhook.