Pinata Webhook Event Types

This is the list of event types that we currently send.
For guidance on how to listen to these events, take a look at Svix's guide to consuming webhooks.

ipfs.private.file_added

Event emitted when a file is added to private IPFS

Example

JSON

{
  "data": {
    "object": {
      "cid": "bafybeifhh5a2o4ilxviboof4c75kkv62hkljpdq3fo3uowkhdrgjr67kbm",
      "created_at": "2025-01-07T20:13:39.536Z",
      "group_id": "11111111-1111-1111-1111-111111111111",
      "id": "11111111-1111-1111-1111-111111111111",
      "keyvalues": {
        "examplekey": "example value",
        "examplekey2": "example value 2"
      },
      "mime_type": "image/png",
      "name": "001.png",
      "number_of_files": 42,
      "size": 42
    }
  },
  "event_type": "ipfs.private.file_added",
  "timestamp": "2025-01-08T16:01:57.025041Z",
  "workspace_id": "11111111-1111-1111-1111-111111111111"
}

ipfs.private.file_deleted

Event emitted when a file is deleted from private ipfs

Example

JSON

{
  "data": {
    "object": {
      "cid": "bafybeifhh5a2o4ilxviboof4c75kkv62hkljpdq3fo3uowkhdrgjr67kbm",
      "created_at": "2025-01-07T20:13:39.536Z",
      "group_id": "11111111-1111-1111-1111-111111111111",
      "id": "11111111-1111-1111-1111-111111111111",
      "keyvalues": {
        "examplekey": "example value",
        "examplekey2": "example value 2"
      },
      "mime_type": "image/png",
      "name": "001.png",
      "number_of_files": 42,
      "size": 42
    }
  },
  "event_type": "ipfs.private.file_deleted",
  "timestamp": "2025-01-08T16:01:57.025041Z",
  "workspace_id": "11111111-1111-1111-1111-111111111111"
}

ipfs.public.file_added

Event emitted when a file is added to public ipfs

Example

JSON

{
  "data": {
    "object": {
      "cid": "bafybeifhh5a2o4ilxviboof4c75kkv62hkljpdq3fo3uowkhdrgjr67kbm",
      "created_at": "2025-01-07T20:13:39.536Z",
      "group_id": "11111111-1111-1111-1111-111111111111",
      "id": "11111111-1111-1111-1111-111111111111",
      "keyvalues": {
        "examplekey": "example value",
        "examplekey2": "example value 2"
      },
      "mime_type": "image/png",
      "name": "001.png",
      "number_of_files": 42,
      "size": 42
    },
    "source": "direct_upload"
  },
  "event_type": "ipfs.public.file_added",
  "timestamp": "2025-01-08T16:01:57.025041Z",
  "workspace_id": "11111111-1111-1111-1111-111111111111"
}

ipfs.public.file_deleted

Event emitted when a file is deleted from public ipfs

Example

JSON

{
  "data": {
    "object": {
      "cid": "bafybeifhh5a2o4ilxviboof4c75kkv62hkljpdq3fo3uowkhdrgjr67kbm",
      "created_at": "2025-01-07T20:13:39.536Z",
      "group_id": "11111111-1111-1111-1111-111111111111",
      "id": "11111111-1111-1111-1111-111111111111",
      "keyvalues": {
        "examplekey": "example value",
        "examplekey2": "example value 2"
      },
      "mime_type": "image/png",
      "name": "001.png",
      "number_of_files": 42,
      "size": 42
    }
  },
  "event_type": "ipfs.public.file_deleted",
  "timestamp": "2025-01-08T16:01:57.025041Z",
  "workspace_id": "11111111-1111-1111-1111-111111111111"
}