v1

latestOpenAPI 3.0.02026-07-24115101.2 MB

Webhooks

Create a webhook

Use this endpoint to create a new webhook.

post/webhooks

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.

integration_process_idinteger nullable

This is a feature for the future, and the default value is null.

sign_keystring nullable

A key to authenticate the webhook requests.

template_group_idinteger nullable

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.

integration_process_idinteger nullable required

This is a feature for the future, and the default value is null.

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
          ]
        }
      ]
    }
  ]
}