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.private.file_updated
When a private file's metadata is updated
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": {
"key": "value"
},
"mime_type": "image/png",
"name": "pinata.png",
"number_of_files": 42,
"size": 42
},
"previous_attributes": {
"group_id": "00000000-0000-0000-0000-000000000000",
"keyvalues": {
"key": "oldValue"
},
"name": "old-pinata.png"
}
},
"event_type": "ipfs.private.file_updated",
"timestamp": "2025-02-05T20:10:54.111334Z",
"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"
}ipfs.public.file_updated
When a public file's metadata is updated
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": {
"key": "value"
},
"mime_type": "image/png",
"name": "pinata.png",
"number_of_files": 42,
"size": 42
},
"previous_attributes": {
"group_id": "00000000-0000-0000-0000-000000000000",
"keyvalues": {
"key": "oldValue"
},
"name": "old-pinata.png"
}
},
"event_type": "ipfs.public.file_updated",
"timestamp": "2025-02-05T20:10:54.111334Z",
"workspace_id": "11111111-1111-1111-1111-111111111111"
}ipfs.public.pin_by_cid_added
When a pin by cid task has been queued
Example
JSON
{
"data": {
"object": {
"cid": "bafybeifhh5a2o4ilxviboof4c75kkv62hkljpdq3fo3uowkhdrgjr67kbm",
"date_queued": "2025-02-05T17:15:20.839Z",
"group_id": "11111111-1111-1111-1111-111111111111",
"host_nodes": [
"/ip4/123.456.78.90/tcp/4001/ipfs/QmAbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIjKlMnOpQr"
],
"id": "11111111-1111-1111-1111-111111111111",
"keyvalues": {
"key": "value"
},
"name": "my awesome file",
"status": "prechecking"
}
},
"event_type": "ipfs.public.pin_by_cid_added",
"timestamp": "2025-02-05T20:10:54.111334Z",
"workspace_id": "11111111-1111-1111-1111-111111111111"
}ipfs.public.pin_by_cid_failed
When pinata fails to retrieve the contents for a pin by cid task.
Example
JSON
{
"data": {
"object": {
"cid": "bafybeifhh5a2o4ilxviboof4c75kkv62hkljpdq3fo3uowkhdrgjr67kbm",
"date_queued": "2025-02-05T17:15:20.839Z",
"group_id": "11111111-1111-1111-1111-111111111111",
"host_nodes": [
"/ip4/123.456.78.90/tcp/4001/ipfs/QmAbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIjKlMnOpQr"
],
"id": "11111111-1111-1111-1111-111111111111",
"keyvalues": {
"key": "value"
},
"name": "my awesome file",
"status": "expired"
}
},
"event_type": "ipfs.public.pin_by_cid_failed",
"timestamp": "2025-02-05T20:10:54.111334Z",
"workspace_id": "11111111-1111-1111-1111-111111111111"
}ipfs.public.pin_by_cid_succeeded
When Pinata successfully pins a piece of content from the Public IPFS network
Example
JSON
{
"data": {
"new_file": {
"cid": "bafybeifhh5a2o4ilxviboof4c75kkv62hkljpdq3fo3uowkhdrgjr67kbm",
"created_at": "2025-02-05T17:15:21.989Z",
"group_id": "11111111-1111-1111-1111-111111111111",
"id": "11111111-1111-1111-1111-111111111111",
"keyvalues": {
"key": "value"
},
"mime_type": "image/gif",
"name": "pinata.gif",
"number_of_files": 1,
"size": 6817
},
"object": {
"cid": "bafybeifhh5a2o4ilxviboof4c75kkv62hkljpdq3fo3uowkhdrgjr67kbm",
"date_queued": "2025-02-05T17:15:20.839Z",
"group_id": "11111111-1111-1111-1111-111111111111",
"host_nodes": [
"/ip4/123.456.78.90/tcp/4001/ipfs/QmAbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIjKlMnOpQr"
],
"id": "11111111-1111-1111-1111-111111111111",
"keyvalues": {
"key": "value"
},
"name": "my awesome file",
"status": "prechecking"
}
},
"event_type": "ipfs.public.pin_by_cid_created",
"timestamp": "2025-02-05T20:10:54.111334Z",
"workspace_id": "11111111-1111-1111-1111-111111111111"
}