Update a webhook

PUT

api

company

webhooks

{id}

curl --request PUT \
  --url https://api.fluid.app/api/company/webhooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhook": {
    "active": false
  }
}
'

{
  "webhook": {
    "id": 123,
    "company_id": 123,
    "droplet_installation_uuid": "<string>",
    "url": "<string>",
    "active": true,
    "resource": "<string>",
    "event": "<string>",
    "event_identifier": "<string>",
    "auth_token": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>"
}

{
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer token authentication

Path Parameters

string

required

Identifier of the webhook subscription — the numeric id returned at create, carried as a path segment.

Body

application/json

webhook

object

Show child attributes

Response

Webhook updated

webhook

object

required

Webhook subscription

Show child attributes

meta

object

Show child attributes

Show a webhook

Delete a webhook

curl --request PUT \
  --url https://api.fluid.app/api/company/webhooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhook": {
    "active": false
  }
}
'

{
  "webhook": {
    "id": 123,
    "company_id": 123,
    "droplet_installation_uuid": "<string>",
    "url": "<string>",
    "active": true,
    "resource": "<string>",
    "event": "<string>",
    "event_identifier": "<string>",
    "auth_token": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>"
}

{
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Overview

Task guides

Endpoints

Auth endpoints

Checkout endpoints

Public SDK endpoints

Payment gateway endpoints

Cart payment endpoints

Commerce endpoints

Webhooks endpoints

Update a webhook

Authorizations

Path Parameters

Body

Response