[lightMode]

Update Webhook

PUT/webhooks/{id}

[updatedIn] 2 months ago

This endpoint allows you to update an existing webhook by passing the id as path parameter

:::tip[Note]

The webhook used is to notify/update/delete an external service when an event has occurred.
To trigger your webhook to send data, you can choose one event from the List Events endpoint.
:::

:::info[Information]
Read more on Webhooks here.
:::

:::caution[Alert]
• New subscriptions with the same URL will update events / restore old webhooks (if they exist).
• The added URL must accept PUT requests.
• By default, all new webhooks are registered as version 2. To use version 1, specify it in your request parameters.
:::

`webhooks.read_write`- Webhooks Read & Write

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

to [header]，whose value is to concatenate the Token after the Bearer.

[api.label.example]

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

[message.pathParameter]

integer

required

Webhook ID. Get a list of Webhooks IDs from [here]https://docs.salla.dev/api-5394135)

Example:

773200552

name

string

optional

Webhook name. List of Webhook names can be found here.

Example:

Salla Update Customer Event

url

string

optional

Webhook registered URL. requiredif no ID is passed.

Example:

https://webhook.site/07254470-c763-4ee3-bef1-ab2480262814

version

enum<integer>

optional

Version of the webhook; either valued as 1 or 2

Allowed values:

Example:

rule

string

optional

Operations, expressions and conditions to your webhook. For example, you may use =,!=,AND,OR etc in such a menner: payment_method = YOUR_PAYMENT_METHOD or in combination company_id = 871291 OR price < 50. That adds more capbility to filter the response based on conditions

Example:

payment_method = mada OR price < 50

headers

array [object {2}]

optional

Webhook headers

key

string

optional

Any header key, which its value is sent in the post request to the webhook URL

Example:

Your Secret token key name

value

string

optional

The value sent to the webhook; for example: cf-ray: 669af54ecf55dfcb-FRA

Example:

Your Secret token value

security_strategy

string | null

optional

in:signature,token

secret

string

optional

required_if:security_strategy,signature

{
  "name": "Salla Update Customer Evensst",
  "version": 2,
  "rule": "payment_method = mada OR price < 50",
  "headers": [
    {
      "key": "Your Secret token key name",
      "value": "Your Secret token value"
    }
  ]
}

Request samples

[api.label.responses]

Success(200)

Error Validation(422)

HTTP Code: 200

Content Type : JSONapplication/json

status

integer

required

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

required

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

object

required

integer

required

Webhook ID

name

string

required

Webhook name

event

string

required

Webhook event

version

integer

required

Webhook version

rule

string

required

Webhook rule

url

string

required

Webhook url

headers

object

required

type

string

required

Webhook type

security

object

required

{
  "status": 200,
  "success": true,
  "data": {
    "id": 773200552,
    "name": "Salla Update Customer Evensst",
    "event": "test",
    "version": 2,
    "rule": "payment_method = mada OR price < 50",
    "url": "https://webhook.site/fake_url",
    "headers": {
      "Your Secret token key name": "Your Secret token value"
    },
    "type": "manual",
    "security": {
      "strategy": "",
      "secret": null
    }
  }
}

[updatedIn] 2 months ago