Update a webhook endpoint

PATCH

/v1/webhook-endpoints/{webhook_endpoint_id}

curl --request PATCH \
  --url https://api.feitpay.com/v1/webhook-endpoints/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "url": "https://example.com", "description": "example", "enabled_events": [ "example" ], "status": "enabled" }'

• GRYPHEM PAY API

Authorizations

• ApiKey
• Session

Parameters

Path Parameters

webhook_endpoint_id

required

string

Header Parameters

Gryphem-Organization

string

Active organization for dashboard sessions. Ignored for API keys (the key determines the organization).

Request Body^required

Media typeapplication/json

object

url

string format: uri

<= 2048 characters

description

string

<= 200 characters

enabled_events

Array<string>

>= 1 items

status

string

Allowed values: enabled disabled

Responses

200

Updated.

Media typeapplication/json

object

id

required

string

object

required

string

Allowed value: webhook_endpoint

livemode

required

boolean

url

required

string

description

required

string

enabled_events

required

Array

store_id

required

string | null

status

required

string

Allowed values: enabled disabled

secret_last4

required

string | null

secret_rotated_at

required

string | null format: date-time

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

{
  "object": "webhook_endpoint",
  "enabled_events": [
    "payment_intent.created"
  ],
  "status": "enabled"
}

401

Missing or invalid credentials.

Media typeapplication/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

403

Authenticated but not permitted.

Media typeapplication/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

404

Resource not found (or not visible to this tenant).

Media typeapplication/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

422

Validation failed.

Media typeapplication/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

429

Too many requests. See Retry-After.

Media typeapplication/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

Headers

Retry-After

integer