Update Webhook

curl --request PUT \
  --url https://sandbox.api.paylias.xyz/gateway/api/v1/csp/webhook/{webhook_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --header 'x-partner-id: <x-partner-id>' \
  --data '
{
  "name": "Payment Webhook",
  "endpoint": "https://example.com/webhook",
  "events": [
    {
      "record_type": "RT_PaymentSubmissions",
      "event_type": "EK_Created"
    },
    {
      "record_type": "RT_PaymentSubmissions",
      "event_type": "EK_Updated"
    }
  ],
  "enabled": true,
  "secret": "ASDLKJASDFLKJ121232342"
}
'

{
  "data": {
    "description": "Webhook to consume link events",
    "endpoint": "https://www.postb.in/1743272420303-9920796800870",
    "enabled": false,
    "events": [
      {
        "record_type": "RT_PaymentSubmissions",
        "event_type": "EK_Created"
      },
      {
        "record_type": "RT_PaymentSubmissions",
        "event_type": "EK_Updated"
      }
    ],
    "name": "Link Events",
    "secret": "2ff46f215a5bb7da8f7fda9b2b0c9ef86c9e7de6"
  },
  "ok": true
}

Webhooks

Update Webhook

Webhooks can be updated by provinding the below listed parameters.

Setting a webhook secret allows you to ensure that POST requests sent to the payload URL are from GitHub. When you set a secret, you’ll receive the X-PAYLIAS-SIGNATURE header in the webhook POST request.

The add_events array allows your webhook to subscribe to additional events while the remove_events array will unsubscribe the events from your webhook. Please note that the uniqueness constraint from the section above still applies.

PUT

api

csp

webhook

{webhook_id}

Update Webhook

curl --request PUT \
  --url https://sandbox.api.paylias.xyz/gateway/api/v1/csp/webhook/{webhook_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --header 'x-partner-id: <x-partner-id>' \
  --data '
{
  "name": "Payment Webhook",
  "endpoint": "https://example.com/webhook",
  "events": [
    {
      "record_type": "RT_PaymentSubmissions",
      "event_type": "EK_Created"
    },
    {
      "record_type": "RT_PaymentSubmissions",
      "event_type": "EK_Updated"
    }
  ],
  "enabled": true,
  "secret": "ASDLKJASDFLKJ121232342"
}
'

{
  "data": {
    "description": "Webhook to consume link events",
    "endpoint": "https://www.postb.in/1743272420303-9920796800870",
    "enabled": false,
    "events": [
      {
        "record_type": "RT_PaymentSubmissions",
        "event_type": "EK_Created"
      },
      {
        "record_type": "RT_PaymentSubmissions",
        "event_type": "EK_Updated"
      }
    ],
    "name": "Link Events",
    "secret": "2ff46f215a5bb7da8f7fda9b2b0c9ef86c9e7de6"
  },
  "ok": true
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-partner-id

string

default:""

required

The Partner ID header used for authorization

idempotency-key

string

default:""

required

The Idempotency Key - usually a UUID

Path Parameters

webhook_id

string

required

The unique identifier for the webhook

Example:

"whk_cjf0qivsemvkg2on8f9g"

Body

application/json

Request to update an existing webhook

enabled

boolean

required

Whether the webhook is enabled

Example:

true

endpoint

string

required

Endpoint URL of the webhook

Example:

"https://example.com/webhook"

name

string

required

Name of the webhook

Example:

"Payment Webhook"

description

string

Description of the webhook

Example:

"Payment notifications"

add_events

object[]

List of events the webhook subscribes to

Show child attributes

add_events.record_type

enum<string>

Type of record for the event

Available options:

RT_PaymentSubmissions,

RT_Error,

RT_Payments,

RT_PaymentAdmissions,

RT_PaymentAdmissionTasks,

RT_Transactions

Example:

"RT_PaymentSubmissions"

add_events.event_type

enum<string>

Type of event

Available options:

EK_Created,

EK_Updated

Example:

"EK_Created"

remove_events

object[]

List of events the webhook subscribes to

Show child attributes

remove_events.record_type

enum<string>

Type of record for the event

Available options:

RT_PaymentSubmissions,

RT_Error,

RT_Payments,

RT_PaymentAdmissions,

RT_PaymentAdmissionTasks,

RT_Transactions

Example:

"RT_PaymentSubmissions"

remove_events.event_type

enum<string>

Type of event

Available options:

EK_Created,

EK_Updated

Example:

"EK_Created"

secret

string

Secret for webhook signature verification

Example:

"ASDLKJASDFLKJ121232342"

Response

Successful retrieval of a webhook subscription

Standard response structure for successful operations

boolean

Indicates if the operation was successful

Example:

true

data

object

Contains the response data Webhook information

Show child attributes

data.created_at

object

A timestamp with seconds since epoch

Show child attributes

data.created_at.seconds

number<int64>

Time in seconds since epoch

Example:

1691831179

data.description

string

Description of the webhook

Example:

"Payment notifications"

data.enabled

boolean

Whether the webhook is enabled

Example:

true

data.endpoint

string

Endpoint URL of the webhook

Example:

"https://example.com/webhook"

data.events

object[]

List of events the webhook subscribes to

Show child attributes

data.events.created_at

object

A timestamp with seconds since epoch

Show child attributes

data.events.created_at.seconds

number<int64>

Time in seconds since epoch

Example:

1691831179

data.events.token

string

Event identifier token

Example:

"evt_123456789"

data.events.record_type

enum<string>

Type of record for the event

Available options:

RT_PaymentSubmissions,

RT_Error,

RT_Payments,

RT_PaymentAdmissions,

RT_PaymentAdmissionTasks,

RT_Transactions

Example:

"RT_PaymentSubmissions"

data.events.event_type

enum<string>

Type of event

Available options:

EK_Created,

EK_Updated

Example:

"EK_Created"

data.events.updated_at

object

A timestamp with seconds since epoch

Show child attributes

data.events.updated_at.seconds

number<int64>

Time in seconds since epoch

Example:

1691831179

data.events.webhook_id

string

Webhook identifier

Example:

"whk_123456789"

data.name

string

Name of the webhook

Example:

"Payment Webhook"

data.partner_id

string

Partner identifier

Example:

"part_123456789"

data.secret

string

Secret for webhook signature verification

Example:

"whsec_123456789"

data.token

string

Webhook identifier token

Example:

"whk_123456789"

data.updated_at

object

A timestamp with seconds since epoch

Show child attributes

data.updated_at.seconds

number<int64>

Time in seconds since epoch

Example:

1691831179

Find Webhook Delete Webhook

⌘I

API documentation

Authorizations

Headers

Path Parameters

Body

Response