---
updatedAt: 2025-06-13T00:00:33.000Z
agentTools:
  projectIndex: https://docs.fiatrepublic.com/llms.txt
---

# Create Webhook

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "transaction-monitoring",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://sandbox-oxygen.fiatrepublic.com/api/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/webhooks": {
      "post": {
        "summary": "Create Webhook",
        "description": "",
        "operationId": "oxygen-create-webhook",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string",
                    "description": "URL on which you want to receive the events."
                  },
                  "description": {
                    "type": "string",
                    "description": "Optional description for the Webhook."
                  },
                  "status": {
                    "type": "string",
                    "description": "Status of the webhook",
                    "enum": [
                      "ENABLED",
                      "DISABLED"
                    ]
                  },
                  "metadata": {
                    "type": "array",
                    "description": "Additional data",
                    "items": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "201",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"url\": \"https://test.com/webhooks/events/OxygenWhks\",\n    \"description\": \"Oxy webhook\",\n    \"status\": \"ENABLED\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "url": {
                      "type": "string",
                      "example": "https://test.com/webhooks/events/OxygenWhks"
                    },
                    "description": {
                      "type": "string",
                      "example": "Oxy webhook"
                    },
                    "status": {
                      "type": "string",
                      "example": "ENABLED"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"errorCode\": \"INVALID_REQUEST_DATA\",\n    \"message\": \"Invalid WebhookRequest.\",\n    \"warnings\": [\n        {\n            \"position\": \"url\",\n            \"issue\": \"http:/test:8000/test/accounts/webhooks is not a valid url\"\n        }\n    ]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "errorCode": {
                      "type": "string",
                      "example": "INVALID_REQUEST_DATA"
                    },
                    "message": {
                      "type": "string",
                      "example": "Invalid WebhookRequest."
                    },
                    "warnings": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "position": {
                            "type": "string",
                            "example": "url"
                          },
                          "issue": {
                            "type": "string",
                            "example": "http:/test:8000/test/accounts/webhooks is not a valid url"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```