Webhooks

Creates a webhook subscription.

Requires Admin. The response carries the signing secret, which is never shown again. Supports the Idempotency-Key header. A subscription past the plan's webhook cap is a 403 plan_limit_reached.

post/api/v1/orgs/{org}/webhooks

Request

  • Base URL: https://api.featureflip.io
  • URL: https://api.featureflip.io/api/v1/orgs/{org}/webhooks
  • Auth: API key in header Authorization

Path parameters

orgstring required

Request body

namestring nullable required
urlstring nullable required
provider'GenericHttp' nullable required

Allowed values: GenericHttp.

eventTypesstring[] nullable
projectIdsstring[] nullable
environmentIdsstring[] nullable

Example request

{
  "name": "Checkout flag changes to Slack relay",
  "url": "https://hooks.acme.example/featureflip",
  "provider": "GenericHttp",
  "eventTypes": [
    "flag.toggled",
    "flag.updated"
  ],
  "projectIds": [
    "0197b69f-1a2b-7c3d-8e4f-5a6b7c8d9e0f"
  ],
  "environmentIds": [
    "0197b69f-2b3c-7d4e-9f5a-6b7c8d9e0f1a"
  ]
}

Response

Created

idstring uuid required
secretstring nullable required
warningstring nullable required

Example response

{
  "id": "0197b6a4-6f7a-7b8c-9d0e-1f2a3b4c5d6e",
  "secret": "whsec_q2Vb8XJ1s0mYpZ4tK7wRr3uN9cL6aD5eF1gH2iJ3kL4=",
  "warning": "Store this secret securely — it will not be shown again."
}

Changes

No recorded changes to this operation across all 1 revision of this API.