Webhooks

APIResponseSchema-array_WebhookResponse

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

POST/account/{accountID}/webhook

curl https://api.fluxis.us/v1/account/:accountID/webhook \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-fluxis-api-key: <api-key>' \
  --header 'Authorization: <api-key>' \
  --data '{
  "description": "description",
  "event_type": "payment_request",
  "url": "url"
}'

Example Request Body

{
  "description": "description",
  "event_type": "payment_request",
  "url": "url"
}

json

Example Responses

{
  "data": {
    "account_id": "account_id",
    "created_at": "created_at",
    "description": "description",
    "enabled": true,
    "event_type": "payment_request",
    "id": "id",
    "secret": "secret",
    "updated_at": "updated_at",
    "url": "url"
  },
  "status": "success"
}

json

application/json

List webhooks

GET

https://api.fluxis.us/v1

/account/{accountID}/webhook/list

x-fluxis-api-key (header)

+Authorization (header)

List all webhooks for an account

List webhooks › path Parameters

accountID

string · required

Account ID

List webhooks › Responses

WebhookResponse[]

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Get webhook logs

GET

https://api.fluxis.us/v1

/account/{accountID}/webhook/logs

x-fluxis-api-key (header)

+Authorization (header)

Get the logs of webhooks for an account

Get webhook logs › path Parameters

accountID

string · required

Account ID

Get webhook logs › Responses

APIResponseSchema-PaginatedResponse-core-api_src_domain_model_WebhookLogModel

PaginatedResponse-core-api_src_domain_model_WebhookLogModel

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Activate webhook

PATCH

https://api.fluxis.us/v1

/account/{accountID}/webhook/{webhookID}/activate

x-fluxis-api-key (header)

+Authorization (header)

Activate a webhook

Activate webhook › path Parameters

accountID

string · required

Account ID

webhookID

string · required

Webhook ID

Activate webhook › Responses

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Deactivate webhook

PATCH

https://api.fluxis.us/v1

/account/{accountID}/webhook/{webhookID}/deactivate

x-fluxis-api-key (header)

+Authorization (header)

Deactivate a webhook

Deactivate webhook › path Parameters

accountID

string · required

Account ID

webhookID

string · required

Webhook ID

Deactivate webhook › Responses

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Delete webhook

DELETE

https://api.fluxis.us/v1

/account/{accountID}/webhook/{webhookID}/delete

x-fluxis-api-key (header)

+Authorization (header)

Delete a webhook

Delete webhook › path Parameters

accountID

string · required

Account ID

webhookID

string · required

Webhook ID

Delete webhook › Responses

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Test webhook

POST

https://api.fluxis.us/v1

/account/{accountID}/webhook/{webhookID}/test

x-fluxis-api-key (header)

+Authorization (header)

Test a webhook

Test webhook › path Parameters

accountID

string · required

Account ID

webhookID

string · required

Webhook ID

Test webhook › Responses

WebhookUpdateURLRequestSchema

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Update webhook URL

PUT

https://api.fluxis.us/v1

/account/{accountID}/webhook/{webhookID}/url

x-fluxis-api-key (header)

+Authorization (header)

Update the URL of a webhook

Update webhook URL › path Parameters

accountID

string · required

Account ID

webhookID

string · required

Webhook ID

Update webhook URL › Request Body

url

string · required

Update webhook URL › Responses

Transactions Integrations

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

PUT/account/{accountID}/webhook/{webhookID}/url

curl https://api.fluxis.us/v1/account/:accountID/webhook/:webhookID/url \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'x-fluxis-api-key: <api-key>' \
  --header 'Authorization: <api-key>' \
  --data '{
  "url": "https://example.com/webhook"
}'

Example Request Body

{
  "url": "https://example.com/webhook"
}

json

application/json

Example Responses

{
  "data": {
    "account_id": "account_id",
    "created_at": "created_at",
    "description": "description",
    "enabled": true,
    "event_type": "payment_request",
    "id": "id",
    "secret": "secret",
    "updated_at": "updated_at",
    "url": "url"
  },
  "status": "success"
}

json

application/json

Fluxis Core API

Webhooks

Server

Create webhook

POST

https://api.fluxis.us/v1

/account/{accountID}/webhook

x-fluxis-api-key (header)

+Authorization (header)

Create a new webhook for an account

Create webhook › path Parameters

accountID

string · required

Account ID

Create webhook › Request Body

WebhookCreateRequest

event_type

core-api_src_domain_types.WebhookEventType · enum · required

Enum values:

payment_request

incoming_transfer

refund

url

string · required

description

string

Create webhook › Responses

APIResponseSchema-array_WebhookResponse

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

POST/account/{accountID}/webhook

curl https://api.fluxis.us/v1/account/:accountID/webhook \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-fluxis-api-key: <api-key>' \
  --header 'Authorization: <api-key>' \
  --data '{
  "description": "description",
  "event_type": "payment_request",
  "url": "url"
}'

Example Request Body

{
  "description": "description",
  "event_type": "payment_request",
  "url": "url"
}

json

Example Responses

{
  "data": {
    "account_id": "account_id",
    "created_at": "created_at",
    "description": "description",
    "enabled": true,
    "event_type": "payment_request",
    "id": "id",
    "secret": "secret",
    "updated_at": "updated_at",
    "url": "url"
  },
  "status": "success"
}

json

application/json

List webhooks

GET

https://api.fluxis.us/v1

/account/{accountID}/webhook/list

x-fluxis-api-key (header)

+Authorization (header)

List all webhooks for an account

List webhooks › path Parameters

accountID

string · required

Account ID

List webhooks › Responses

WebhookResponse[]

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Get webhook logs

GET

https://api.fluxis.us/v1

/account/{accountID}/webhook/logs

x-fluxis-api-key (header)

+Authorization (header)

Get the logs of webhooks for an account

Get webhook logs › path Parameters

accountID

string · required

Account ID

Get webhook logs › Responses

APIResponseSchema-PaginatedResponse-core-api_src_domain_model_WebhookLogModel

PaginatedResponse-core-api_src_domain_model_WebhookLogModel

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Activate webhook

PATCH

https://api.fluxis.us/v1

/account/{accountID}/webhook/{webhookID}/activate

x-fluxis-api-key (header)

+Authorization (header)

Activate a webhook

Activate webhook › path Parameters

accountID

string · required

Account ID

webhookID

string · required

Webhook ID

Activate webhook › Responses

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Deactivate webhook

PATCH

https://api.fluxis.us/v1

/account/{accountID}/webhook/{webhookID}/deactivate

x-fluxis-api-key (header)

+Authorization (header)

Deactivate a webhook

Deactivate webhook › path Parameters

accountID

string · required

Account ID

webhookID

string · required

Webhook ID

Deactivate webhook › Responses

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Delete webhook

DELETE

https://api.fluxis.us/v1

/account/{accountID}/webhook/{webhookID}/delete

x-fluxis-api-key (header)

+Authorization (header)

Delete a webhook

Delete webhook › path Parameters

accountID

string · required

Account ID

webhookID

string · required

Webhook ID

Delete webhook › Responses

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Test webhook

POST

https://api.fluxis.us/v1

/account/{accountID}/webhook/{webhookID}/test

x-fluxis-api-key (header)

+Authorization (header)

Test a webhook

Test webhook › path Parameters

accountID

string · required

Account ID

webhookID

string · required

Webhook ID

Test webhook › Responses

WebhookUpdateURLRequestSchema

Response data (only for success status)

status

core-api_src_infrastructure_http_types.ResponseStatus · enum

Response status

Enum values:

success

error

Update webhook URL

PUT

https://api.fluxis.us/v1

/account/{accountID}/webhook/{webhookID}/url

x-fluxis-api-key (header)

+Authorization (header)

Update the URL of a webhook

Update webhook URL › path Parameters

accountID

string · required

Account ID

webhookID

string · required

Webhook ID

Update webhook URL › Request Body

url

string · required

Update webhook URL › Responses