ONoneflow
Webhooks

Create a webhook

Changed on

Use this endpoint to create a new webhook.

post/webhooks

Request

  • Base URL
    https://api.oneflow.com/v1
  • Auth
    none declared. Required headers: x-oneflow-api-token

Headers

x-oneflow-api-tokenstring required

The API key of your Oneflow account.

x-oneflow-user-emailstring email

The email address of a registered Oneflow user.

Request body

callback_urlstring https_url required

The webhook's callback url.

sign_keystring nullable

A key to authenticate the webhook requests.

template_group_idinteger nullable

This will be deprecated in the future. Use the BLUEPRINT type filter instead as part of the Multiple Integrations migration.

Example request

{
  "callback_url": "https://example.org/webhook/test1",
  "filters": [
    {
      "filter_rules": [
        {
          "values": [
            130001
          ]
        }
      ]
    }
  ]
}

Response

Returns the created webhook.

callback_urlstring nullable required

The webhook's callback url.

integration_instanceinteger nullable required

Connected integration instance.

legacy_webhookboolean required

True if the webhook is a legacy webhook.

template_group_idinteger nullable required
webhook_idinteger required

webhook ID

Example response

{
  "filters": [
    {
      "filter_rules": [
        {
          "values": [
            130001
          ]
        }
      ]
    }
  ]
}

Changes

  • 0a4e1e88ac45Revision changes
    • breaking

      added subschema #4: Playbook to the /// response property oneOf list for the response status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • info

      added subschema #4: Playbook to the /// request property oneOf list