---
updatedAt: 2026-06-09T01:29:16.000Z
agentTools:
  projectIndex: https://docs.gliderpay.com/llms.txt
---

# Create Webhook

This API will allow to create webhook.  
This can be used to monitor certain events of invoices whether is was opened, paid, or a declined transaction was triggered

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Glider",
    "description": "All the api you need to know for Glider (former MeekiMoney)",
    "contact": {},
    "version": "2.0"
  },
  "x-readme": {
    "metrics-enabled": false,
    "samples-languages": [
      "node",
      "javascript",
      "http",
      "shell",
      "python"
    ]
  },
  "servers": [
    {
      "url": "https://api-uat.gliderpay.com",
      "description": "Sandbox"
    },
    {
      "url": "https://api.gliderpay.com",
      "description": "Production"
    }
  ],
  "paths": {
    "/v2/webhook": {
      "post": {
        "tags": [
          "Webhook"
        ],
        "summary": "Create Webhook",
        "description": "This API will allow to create webhook.  \nThis can be used to monitor certain events of invoices whether is was opened, paid, or a declined transaction was triggered",
        "operationId": "CreateWebhook",
        "parameters": [],
        "requestBody": {
          "description": "",
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/WebhookRequestObject"
                  },
                  {
                    "$ref": "#/components/schemas/WebhookEmailRequestObject"
                  }
                ]
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookResponseObject"
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": [
          {
            "bearer": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "Config": {
        "title": "Config",
        "required": [
          "failureThreshold",
          "batchingIntervalInMinutes",
          "callbackUrl",
          "events"
        ],
        "type": "object",
        "properties": {
          "failureThreshold": {
            "type": "integer",
            "description": "Maximum number of retries",
            "example": 3
          },
          "batchingIntervalInMinutes": {
            "type": "integer",
            "description": "Number of minutes until retry",
            "example": 1
          },
          "callbackUrl": {
            "type": "string",
            "description": "Callback url to call when an event is triggered"
          },
          "events": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of the events type you want to receive at your webhook endpoint.\nValid values: `declined`, `opened`, `paid`, `partially_paid`, `registered`, `saved`, `under_investigation`",
            "example": [
              "declined",
              "opened",
              "paid",
              "partially_paid",
              "registered",
              "saved",
              "under_investigation"
            ]
          }
        }
      },
      "EmailConfig": {
        "title": "EmailConfig",
        "required": [
          "type",
          "recipients",
          "events"
        ],
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "email"
            ],
            "description": "Constant value of email"
          },
          "recipients": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "email"
            },
            "description": "List of all the email recipients",
            "example": [
              "test1@email.com",
              "test2@email.com"
            ]
          },
          "events": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of the events type you want to receive at your webhook endpoint.\nValid values: `declined`, `opened`, `paid`, `partially_paid`, `registered`, `saved`, `under_investigation`, `overdue`, `paused`, `resumed`, `cancelled`, `stopped`, `completed`,",
            "example": [
              "declined",
              "opened",
              "paid",
              "partially_paid",
              "registered",
              "saved",
              "under_investigation",
              "overdue",
              "paused",
              "resumed",
              "stopped",
              "cancelled",
              "completed"
            ]
          }
        }
      },
      "WebhookEmailRequestObject": {
        "title": "Email Webhook",
        "required": [
          "config",
          "name"
        ],
        "type": "object",
        "properties": {
          "config": {
            "$ref": "#/components/schemas/EmailConfig"
          },
          "name": {
            "type": "string",
            "description": "Webhook name"
          }
        }
      },
      "WebhookRequestObject": {
        "title": "Standard Webhook",
        "required": [
          "config",
          "name"
        ],
        "type": "object",
        "properties": {
          "config": {
            "$ref": "#/components/schemas/Config"
          },
          "name": {
            "type": "string",
            "description": "Webhook name"
          }
        }
      },
      "WebhookResponseObject": {
        "type": "object",
        "title": "Webhook Object",
        "properties": {
          "config": {
            "type": "object",
            "properties": {
              "failureThreshold": {
                "type": "integer",
                "description": "Maximum number of retries",
                "example": 3
              },
              "batchingIntervalInMinutes": {
                "type": "integer",
                "description": "Number of minutes until retry",
                "example": 1
              },
              "callbackUrl": {
                "type": "string",
                "description": "Call back Url to call when an event is triggered",
                "example": "https://webhook.oupower.com"
              },
              "events": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "example": [
                  "declined",
                  "opened",
                  "paid",
                  "partially_paid",
                  "registered",
                  "saved",
                  "under_investigation"
                ],
                "description": "List of the events type you want to receive at your webhook endpoint.\nValid values: `declined`, `opened`, `paid`, `partially_paid`, `registered`, `saved`, `under_investigation`"
              }
            }
          },
          "id": {
            "type": "integer",
            "description": "Webhook identifier",
            "example": "33"
          },
          "name": {
            "type": "string",
            "description": "Webhook name",
            "example": "Test Webhook"
          },
          "active": {
            "type": "boolean",
            "description": "Flag stating whether the record is still active"
          },
          "created": {
            "type": "string",
            "description": "Webhook creation time",
            "example": "2024-05-01 15:52:00"
          }
        }
      }
    },
    "securitySchemes": {
      "bearer": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "security": [],
  "tags": [
    {
      "name": "Webhook"
    }
  ]
}
```