Webhooks

Webhooks can be used to receive notifications when a event happens on the i18nhero platform.

All webhooks are sent using the POST HTTP method.

Events

EventDescription
key:createdTriggered when a new translation is created
key:bulk:createdTriggered when more than one translation is created at once, such as when using the CLI
key:updatedTriggered when a translation is update
key:bulk:updatedTriggered when more than one translation is update at once, such as when using the CLI
key:deletedTriggered when a translation is deleted
key:bulk:deletedTriggered when more than one translation is deleted at once, such as when using the CLI

Payloads

"key:created"

{
  "webhook_id": "string",
  "event": "key:created",
  "payload": {
    "project_id": "string",
    "translation_id": "string"
  }
}

"key:bulk:created"

{
  "webhook_id": "string",
  "event": "key:bulk:created",
  "payload": {
    "project_id": "string"
  }
}

"key:updated"

{
  "webhook_id": "string",
  "event": "key:updated",
  "payload": {
    "project_id": "string",
    "translation_id": "string"
  }
}

"key:bulk:updated"

{
  "webhook_id": "string",
  "event": "key:bulk:updated",
  "payload": {
    "project_id": "string"
  }
}

"key:deleted"

{
  "webhook_id": "string",
  "event": "key:deleted",
  "payload": {
    "project_id": "string",
    "translation_id": "string"
  }
}

"key:bulk:deleted"

{
  "webhook_id": "string",
  "event": "key:bulk:deleted",
  "payload": {
    "project_id": "string"
  }
}