Salla Docs
Merchant API
Partner APIs
Storefront
Salla CLI
Salla Docs
    Light Mode

    Update Webhook

    PUT/webhooks/{id}
    Last modified: 13 days 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

    Path Params
    id
    integer 
    required

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

    Example:
    773200552
    Body Params application/json
    No schema defined
    Example
    {
  "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

    Responses

    Success(200)
    Error Validation(422)
    HTTP Code: 200
    Content Type : JSONapplication/json
    Data Schema
    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
    id
    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
    Example
    {
  "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
    }
  }
}
    Last modified: 13 days ago