​
Authentication

This provider requires authentication.

  • url: Webhook URL (required: True, sensitive: False)
  • verify: Enable SSL verification (required: False, sensitive: False)
  • method: HTTP method (required: True, sensitive: False)
  • http_basic_authentication_username: HTTP basic authentication - Username (required: False, sensitive: False)
  • http_basic_authentication_password: HTTP basic authentication - Password (required: False, sensitive: True)
  • api_key: API key (required: False, sensitive: True)
  • headers: Headers (required: False, sensitive: False)

Certain scopes may be required to perform specific actions or queries via the provider. Below is a summary of relevant scopes and their use cases:

  • send_webhook: (mandatory)

​
In workflows

This provider can be used in workflows.

As “step” to query data, example:

steps:
    - name: Query webhook
      provider: webhook
      config: "{{ provider.my_provider_name }}"
      with:
        url: {value}
        method: {value}
        http_basic_authentication_username: {value}
        http_basic_authentication_password: {value}
        api_key: {value}
        headers: {value}
        body: {value}
        params: {value}
        fail_on_error: {value}

As “action” to make changes or update data, example:

actions:
    - name: Query webhook
      provider: webhook
      config: "{{ provider.my_provider_name }}"
      with:
        body: {value}
        params: {value}

Check the following workflow examples: