Update User Webhook

PATCH 
/api/v2/public/webhooks/user/:webhookId

Updates an existing user webhook. This endpoint allows you to modify the URL, events, or other settings of an already registered user webhook.

Request

Path Parameters

webhookId stringrequired
Webhook id
Example: c8c7913d-3e1f-4e4c-a646-81282ecba2b8

application/json

Body

required

url string

The URL that will be called when an event is triggered.

events string[]required

Possible values: [all, facility.user-connection.accepted, facility.user-connection.rejected, facility.creation.accepted, facility.creation.rejected]

The events that this webhook will listen to.

secrets string[]
  The secrets that will be used to verify the authenticity of the webhook.
  If no value is provided it will auto generate a secret.
  Secrets are used to sign and validate the payload of the webhook.
  It will accept 2 secrets to allow a rotation strategy without service downtime.

Responses

201

application/json

Schema

Schema

data object

id stringrequired

If of the Webhook

url stringrequired

Url of the Webhook

events string[]required

Possible values: [all, facility.user-connection.accepted, facility.user-connection.rejected, facility.creation.accepted, facility.creation.rejected]

List of events that this webhook will listen to

clientId stringrequired

secrets string[]required

List of webhook secrets

Example (from schema)

{
  "data": {
    "id": "d148420d-29af-4a30-8f84-b6dcef1ba886",
    "url": "https://exemple.com/webhook",
    "events": [
      "facility.creation.accepted",
      "facility.user-connection.accepted"
    ],
    "clientId": "string",
    "secrets": [
      "sDV1aKqitCLClI12m7UPFbAAvZfZquJw",
      "mryefgHPBVHJwux0o3BYW7hPM0BZlcCa"
    ]
  }
}

400

Bad request

application/json

Schema

Schema

message string[]

Error description

error string

The type of error

statusCode integer

Status code of the error

Example (from schema)

{
  "message": [
    "Property must be a string"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

Request Validation

Request Validation Error

{
  "message": [
    "should be a secure URL with HTTPS",
    "url must be a string",
    "events must contain at least 1 elements",
    "events must be an array",
    "each value in events must be one of the following values: all, facility.user-connection.accepted, facility.user-connection.rejected, facility.creation.accepted, facility.creation.rejected",
    "secrets must contain no more than 2 elements",
    "secrets must be an array"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

401

Unauthorized

application/json

Schema

Schema

message string

Error description

statusCode integer

Status code of the error

Example (from schema)

{
  "message": "Unauthorized",
  "statusCode": 401
}

403

Forbidden

application/json

Schema

Schema

message string

Error description

error string

The type of error

statusCode integer

Status code of the error

Example (from schema)

{
  "message": "Forbidden Resource",
  "error": "Forbidden",
  "statusCode": 403
}

404

Not Found

application/json

Schema

Schema

message string

Error description

error string

The type of error

statusCode integer

Status code of the error

Example (from schema)

{
  "message": "Not Found",
  "error": "Not Found",
  "statusCode": 404
}

Not Found

Webhook was not found

{
  "message": "Webhook not found",
  "error": "Not Found",
  "statusCode": 404
}

Loading...