fly-io · Schema

ExtensionWebhookPayload

Payload sent by extension providers to notify Fly.io of resource lifecycle changes.

Properties

Name Type Description
action string The lifecycle action that occurred.
resource_id string The provider's ID of the resource this event relates to.
config object Updated environment variable configuration, if applicable. Include when responding to async provisioning completion.
View JSON Schema on GitHub

JSON Schema

fly-io-extensionwebhookpayload-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ExtensionWebhookPayload",
  "title": "ExtensionWebhookPayload",
  "type": "object",
  "description": "Payload sent by extension providers to notify Fly.io of resource lifecycle changes.",
  "required": [
    "action",
    "resource_id"
  ],
  "properties": {
    "action": {
      "type": "string",
      "description": "The lifecycle action that occurred.",
      "enum": [
        "resource.created",
        "resource.updated",
        "resource.deleted"
      ]
    },
    "resource_id": {
      "type": "string",
      "description": "The provider's ID of the resource this event relates to."
    },
    "config": {
      "type": "object",
      "description": "Updated environment variable configuration, if applicable. Include when responding to async provisioning completion.",
      "additionalProperties": {
        "type": "string"
      }
    }
  }
}