Kirim icon

Kirim

Send WhatsApp messages and manage your inbox via the Kirimdev API

Webhook Subscription → Create

AI-generated

Summary

Create a Kirim webhook subscription that sends selected events to a public HTTPS endpoint. The response includes the new subscription details and its plaintext signing secret, which is returned only once.

Inputs

  • URL (required) — Public HTTPS URL that will receive event deliveries; private IP addresses and localhost are rejected.
  • Events (required) — Select one or more event types: contact created or updated, conversation assigned or closed, or message received, sent, or status changed.
  • Description — Optional dashboard label, up to 200 characters.
  • Request Options — Optional request settings for batching, SSL certificate validation, proxy, and timeout.

Output shape

A single webhook subscription record returned by the Kirim API.

The response includes the plaintext signing secret once; save it for verifying incoming webhook deliveries, because it is not returned again.

Links

Discussion