Create a webhook endpoint

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request POST "$LAGO_URL/api/v1/webhook_endpoints" \
  --header "Authorization: Bearer $API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "webhook_endpoint": {
      "webhook_url": "https://foo.bar",
      "signature_algo": "hmac"
    }
  }'

{
  "webhook_endpoint": {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "lago_organization_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "webhook_url": "Prepaid",
    "created_at": "2022-04-29T08:59:51Z",
    "signature_algo": "hmac"
  }
}

POST

webhook_endpoints

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request POST "$LAGO_URL/api/v1/webhook_endpoints" \
  --header "Authorization: Bearer $API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "webhook_endpoint": {
      "webhook_url": "https://foo.bar",
      "signature_algo": "hmac"
    }
  }'

{
  "webhook_endpoint": {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "lago_organization_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "webhook_url": "Prepaid",
    "created_at": "2022-04-29T08:59:51Z",
    "signature_algo": "hmac"
  }
}

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request POST "$LAGO_URL/api/v1/webhook_endpoints" \
  --header "Authorization: Bearer $API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "webhook_endpoint": {
      "webhook_url": "https://foo.bar",
      "signature_algo": "hmac"
    }
  }'

Authorizations

Authorization

string

header

required

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

Body

application/json

Webhook Endpoint payload

webhook_endpoint

object

Show child attributes

webhook_endpoint.webhook_url

string

required

The URL of the webhook endpoint.

Example:

"https://foo.bar"

webhook_endpoint.signature_algo

enum<string> | null

The signature used for the webhook. If no value is passed,

Available options:

jwt,

hmac,

Example:

"hmac"

Response

Webhook Endpoint created

webhook_endpoint

object

required

Show child attributes

webhook_endpoint.lago_id

string<uuid>

required

Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the webhook endpoint's record within the Lago system.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

webhook_endpoint.lago_organization_id

string<uuid>

required

Unique identifier assigned to the organization attached to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the organization's record within the Lago system.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

webhook_endpoint.webhook_url

string

required

The name of the wallet.

Example:

"Prepaid"

webhook_endpoint.created_at

string<date-time>

required

The date of the webhook endpoint creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).

Example:

"2022-04-29T08:59:51Z"

webhook_endpoint.signature_algo

enum<string>

The signature algo for the webhook.

Available options:

jwt,

hmac

Example:

"hmac"

The webhook endpoint object Update a webhook endpoint

⌘I

API Reference

Authorizations

Body

Response