Updates for webhook event log APIs

src/main/api/retrieveWebhookAttemptLog.json

@@ -0,0 +1,20 @@
+{
+  "uri": "/api/system/webhook-attempt-log",
+  "comments": [
+    "Retrieves a single webhook attempt log for the given Id."
+  ],
+  "method": "get",
+  "methodName": "retrieveWebhookAttemptLog",
+  "successResponse": "WebhookAttemptLogResponse",
+  "errorResponse": "Errors",
+  "params": [
+    {
+      "name": "webhookAttemptLogId",
+      "comments": [
+        "The Id of the webhook attempt log to retrieve."
+      ],
+      "type": "urlSegment",
+      "javaType": "UUID"
+    }
+  ]
+}

src/main/api/retrieveWebhookEventLog.json

@@ -0,0 +1,20 @@
+{
+  "uri": "/api/system/webhook-event-log",
+  "comments": [
+    "Retrieves a single webhook event log for the given Id."
+  ],
+  "method": "get",
+  "methodName": "retrieveWebhookEventLog",
+  "successResponse": "WebhookEventLogResponse",
+  "errorResponse": "Errors",
+  "params": [
+    {
+      "name": "webhookEventLogId",
+      "comments": [
+        "The Id of the webhook event log to retrieve."
+      ],
+      "type": "urlSegment",
+      "javaType": "UUID"
+    }
+  ]
+}

src/main/api/searchWebhookEventLogs.json

@@ -0,0 +1,20 @@
+{
+  "uri": "/api/system/webhook-event-log/search",
+  "comments": [
+    "Searches the webhook event logs with the specified criteria and pagination."
+  ],
+  "method": "post",
+  "methodName": "searchWebhookEventLogs",
+  "successResponse": "WebhookEventLogSearchResponse",
+  "errorResponse": "Errors",
+  "params": [
+    {
+      "name": "request",
+      "comments": [
+        "The search criteria and pagination information."
+      ],
+      "type": "body",
+      "javaType": "WebhookEventLogSearchRequest"
+    }
+  ]
+}

src/main/client/java.client.ftl

@@ -171,6 +171,10 @@ import io.fusionauth.domain.api.WebAuthnRegisterStartRequest;
 import io.fusionauth.domain.api.WebAuthnRegisterStartResponse;
 import io.fusionauth.domain.api.WebAuthnStartRequest;
 import io.fusionauth.domain.api.WebAuthnStartResponse;
+import io.fusionauth.domain.api.WebhookAttemptLogResponse;
+import io.fusionauth.domain.api.WebhookEventLogResponse;
+import io.fusionauth.domain.api.WebhookEventLogSearchRequest;
+import io.fusionauth.domain.api.WebhookEventLogSearchResponse;
 import io.fusionauth.domain.api.WebhookRequest;
 import io.fusionauth.domain.api.WebhookResponse;
 import io.fusionauth.domain.api.WebhookSearchRequest;

src/main/domain/io.fusionauth.domain.SystemConfiguration.json

@@ -45,6 +45,9 @@
     },
     "uiConfiguration" : {
       "type" : "UIConfiguration"
+    },
+    "webhookEventLogConfiguration" : {
+      "type" : "WebhookEventLogConfiguration"
     }
   }
 }

src/main/domain/io.fusionauth.domain.WebhookAttemptLog.json

@@ -0,0 +1,55 @@
+{
+  "packageName" : "io.fusionauth.domain",
+  "type" : "WebhookAttemptLog",
+  "description" : "/**\n * A webhook call attempt log.\n *\n * @author Spencer Witt\n */\n",
+  "implements" : [ {
+    "type" : "Buildable",
+    "typeArguments" : [ {
+      "type" : "WebhookAttemptLog"
+    } ]
+  }, {
+    "type" : "Comparable",
+    "typeArguments" : [ {
+      "type" : "WebhookAttemptLog"
+    } ]
+  }, {
+    "type" : "JSONColumnable"
+  } ],
+  "fields" : {
+    "data" : {
+      "type" : "Map",
+      "typeArguments" : [ {
+        "type" : "String"
+      }, {
+        "type" : "Object"
+      } ]
+    },
+    "endInstant" : {
+      "type" : "ZonedDateTime"
+    },
+    "id" : {
+      "type" : "UUID"
+    },
+    "startInstant" : {
+      "type" : "ZonedDateTime"
+    },
+    "webhookCallResponse" : {
+      "type" : "WebhookCallResponse"
+    },
+    "webhookEventLogId" : {
+      "type" : "UUID"
+    },
+    "webhookId" : {
+      "type" : "UUID"
+    },
+    "attemptResult" : {
+      "type" : "WebhookAttemptResult"
+    },
+    "duration" : {
+      "type" : "long"
+    },
+    "url" : {
+      "type" : "String"
+    }
+  }
+}

src/main/domain/io.fusionauth.domain.WebhookAttemptResult.json

@@ -0,0 +1,6 @@
+{
+  "packageName" : "io.fusionauth.domain",
+  "type" : "WebhookAttemptResult",
+  "description" : "/**\n * The possible states of an individual webhook attempt to a single endpoint.\n *\n * @author Spencer Witt\n */\n",
+  "enum" : [ "Success", "Failure", "Unknown" ]
+}

src/main/domain/io.fusionauth.domain.WebhookCallResponse.json

@@ -0,0 +1,22 @@
+{
+  "packageName" : "io.fusionauth.domain",
+  "type" : "WebhookCallResponse",
+  "description" : "/**\n * A webhook call response.\n *\n * @author Spencer Witt\n */\n",
+  "implements" : [ {
+    "type" : "Buildable",
+    "typeArguments" : [ {
+      "type" : "WebhookCallResponse"
+    } ]
+  } ],
+  "fields" : {
+    "exception" : {
+      "type" : "String"
+    },
+    "statusCode" : {
+      "type" : "int"
+    },
+    "url" : {
+      "type" : "URI"
+    }
+  }
+}

src/main/domain/io.fusionauth.domain.WebhookEventLog.json

@@ -0,0 +1,61 @@
+{
+  "packageName" : "io.fusionauth.domain",
+  "type" : "WebhookEventLog",
+  "implements" : [ {
+    "type" : "Buildable",
+    "typeArguments" : [ {
+      "type" : "WebhookEventLog"
+    } ]
+  }, {
+    "type" : "JSONColumnable"
+  } ],
+  "fields" : {
+    "attempts" : {
+      "type" : "List",
+      "typeArguments" : [ {
+        "type" : "WebhookAttemptLog"
+      } ]
+    },
+    "data" : {
+      "type" : "Map",
+      "typeArguments" : [ {
+        "type" : "String"
+      }, {
+        "type" : "Object"
+      } ]
+    },
+    "event" : {
+      "type" : "EventRequest"
+    },
+    "eventResult" : {
+      "type" : "WebhookEventResult"
+    },
+    "eventType" : {
+      "type" : "EventType"
+    },
+    "id" : {
+      "type" : "UUID"
+    },
+    "insertInstant" : {
+      "type" : "ZonedDateTime"
+    },
+    "lastAttemptInstant" : {
+      "type" : "ZonedDateTime"
+    },
+    "lastUpdateInstant" : {
+      "type" : "ZonedDateTime"
+    },
+    "linkedObjectId" : {
+      "type" : "UUID"
+    },
+    "sequence" : {
+      "type" : "long"
+    },
+    "failedAttempts" : {
+      "type" : "int"
+    },
+    "successfulAttempts" : {
+      "type" : "int"
+    }
+  }
+}

src/main/domain/io.fusionauth.domain.WebhookEventLogConfiguration.json

@@ -0,0 +1,10 @@
+{
+  "packageName" : "io.fusionauth.domain",
+  "type" : "WebhookEventLogConfiguration",
+  "description" : "/**\n * The system configuration for Webhook Event Log data.\n *\n * @author Spencer Witt\n */\n",
+  "fields" : {
+    "delete" : {
+      "type" : "DeleteConfiguration"
+    }
+  }
+}

src/main/domain/io.fusionauth.domain.WebhookEventResult.json

@@ -0,0 +1,6 @@
+{
+  "packageName" : "io.fusionauth.domain",
+  "type" : "WebhookEventResult",
+  "description" : "/**\n * The possible result states of a webhook event. This tracks the success of the overall webhook transaction according to the {@link TransactionType}\n * and configured webhooks.\n *\n * @author Spencer Witt\n */\n",
+  "enum" : [ "Failed", "Running", "Succeeded" ]
+}

src/main/domain/io.fusionauth.domain.api.WebhookAttemptLogResponse.json

@@ -0,0 +1,10 @@
+{
+  "packageName" : "io.fusionauth.domain.api",
+  "type" : "WebhookAttemptLogResponse",
+  "description" : "/**\n * Webhook attempt log response.\n *\n * @author Spencer Witt\n */\n",
+  "fields" : {
+    "webhookAttemptLog" : {
+      "type" : "WebhookAttemptLog"
+    }
+  }
+}

src/main/domain/io.fusionauth.domain.api.WebhookEventLogResponse.json

@@ -0,0 +1,16 @@
+{
+  "packageName" : "io.fusionauth.domain.api",
+  "type" : "WebhookEventLogResponse",
+  "description" : "/**\n * Webhook event log response.\n *\n * @author Spencer Witt\n */\n",
+  "implements" : [ {
+    "type" : "Buildable",
+    "typeArguments" : [ {
+      "type" : "WebhookEventLogResponse"
+    } ]
+  } ],
+  "fields" : {
+    "webhookEventLog" : {
+      "type" : "WebhookEventLog"
+    }
+  }
+}

src/main/domain/io.fusionauth.domain.api.WebhookEventLogSearchRequest.json

@@ -0,0 +1,10 @@
+{
+  "packageName" : "io.fusionauth.domain.api",
+  "type" : "WebhookEventLogSearchRequest",
+  "description" : "/**\n * Webhook event log search request.\n *\n * @author Spencer Witt\n */\n",
+  "fields" : {
+    "search" : {
+      "type" : "WebhookEventLogSearchCriteria"
+    }
+  }
+}

src/main/domain/io.fusionauth.domain.api.WebhookEventLogSearchResponse.json

@@ -0,0 +1,16 @@
+{
+  "packageName" : "io.fusionauth.domain.api",
+  "type" : "WebhookEventLogSearchResponse",
+  "description" : "/**\n * Webhook event log search response.\n *\n * @author Spencer Witt\n */\n",
+  "fields" : {
+    "total" : {
+      "type" : "long"
+    },
+    "webhookEventLogs" : {
+      "type" : "List",
+      "typeArguments" : [ {
+        "type" : "WebhookEventLog"
+      } ]
+    }
+  }
+}

src/main/domain/io.fusionauth.domain.event.BaseEvent.json

@@ -1,7 +1,7 @@
 {
   "packageName" : "io.fusionauth.domain.event",
   "type" : "BaseEvent",
-  "description" : "/**\n * Base-class for all FusionAuth events.\n *\n * @author Brian Pontarelli\n */\n",
+  "description" : "/**\n * Base class for all FusionAuth events.\n *\n * @author Brian Pontarelli\n */\n",
   "fields" : {
     "createInstant" : {
       "type" : "ZonedDateTime"

src/main/domain/io.fusionauth.domain.event.BaseGroupEvent.json

@@ -0,0 +1,16 @@
+{
+  "packageName" : "io.fusionauth.domain.event",
+  "type" : "BaseGroupEvent",
+  "description" : "/**\n * Base class for all {@link Group} and {@link GroupMember} events.\n *\n * @author Spencer Witt\n */\n",
+  "extends" : [ {
+    "type" : "BaseEvent"
+  } ],
+  "implements" : [ {
+    "type" : "ObjectIdentifiable"
+  } ],
+  "fields" : {
+    "group" : {
+      "type" : "Group"
+    }
+  }
+}

src/main/domain/io.fusionauth.domain.event.BaseUserEvent.json

@@ -0,0 +1,16 @@
+{
+  "packageName" : "io.fusionauth.domain.event",
+  "type" : "BaseUserEvent",
+  "description" : "/**\n * Base class for all {@link User}-related events.\n *\n * @author Spencer Witt\n */\n",
+  "extends" : [ {
+    "type" : "BaseEvent"
+  } ],
+  "implements" : [ {
+    "type" : "ObjectIdentifiable"
+  } ],
+  "fields" : {
+    "user" : {
+      "type" : "User"
+    }
+  }
+}

src/main/domain/io.fusionauth.domain.event.GroupCreateCompleteEvent.json

@@ -3,7 +3,7 @@
   "type" : "GroupCreateCompleteEvent",
   "description" : "/**\n * Models the Group Created Event.\n *\n * @author Daniel DeGroff\n */\n",
   "extends" : [ {
-    "type" : "BaseEvent"
+    "type" : "BaseGroupEvent"
   } ],
   "implements" : [ {
     "type" : "Buildable",
@@ -13,9 +13,5 @@
   }, {
     "type" : "NonTransactionalEvent"
   } ],
-  "fields" : {
-    "group" : {
-      "type" : "Group"
-    }
-  }
+  "fields" : { }
 }